Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Inline Edit OverviewAllow
Inline Edit OverviewThe Inline Edit allows users to edit content within the context of their work rather than going to an "edit mode". It can be applied to any text, assuming a very simple contract is maintained:
Creating an Inline EditorNote: this convenience method is not yet implemented. You can optionally provide your own markup that will be used for the edit mode, but if not, default markup is provided. CreationCreating a single Inline Edit
Return: The Inline Edit component object. Creating Multiple Inline Edits
Return: An array of the Inline Edit component objects. This function will find any elements within the given container that are identified as 'editables' and apply the Inline Edit component to them.
|
Constructor
Code Block | |||
---|---|---|---|
javascript | |||
fluid.InlineEdit(componentContainerId, options);
|
Parameters
...
componentContainer
The componentContainerId
parameter is the ID of componentContainer
parameter is a selector, a single-element jQuery, or a DOM element specifying the root DOM node of the Inline Edit markup.
Anchor | ||||
---|---|---|---|---|
|
options
The options
parameter is an optional collection of name-value pairs that configure data structure that configures the Inline Edit component(s), as described below in the fluid:Options section.
...
Anchor |
---|
...
|
...
|
...
Default
...
selectors
...
Javascript object containing selectors for various fragments of the Inline Edit markup
...
...
selectors: {
text: ".text",
editContainer: ".editContainer",
edit: ".edit"
}
...
styles
...
...
...
styles: {
invitation: "invitation",
focus: "focus"
}
...
paddings
...
...
...
paddings: {
add: 10,
minimum: 80
}
...
finishedEditing
...
...
...
Supported Events
The Inline Edit component fires the following events (for more information about events in the Fluid Framework, see Events for Component Users):
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||||
---|---|---|---|---|---|---|
|
...
Skinning
This component can be skinned "out of the box" when you include the component's CSS files. Just be sure to put the following in your document:
Code Block | ||||
---|---|---|---|---|
| ||||
<link rel="stylesheet" type="text/css" href="components/inlineEdit/css/InlineEdit.css" />
|
...
Dependencies
The Inline Edit dependencies can be met by including the minified InfusionAll.js
file in the header of the HTML file:
Code Block | ||||
---|---|---|---|---|
| ||||
<script type="text/javascript" src="InfusionAll.js"></script>
|
Alternatively, the individual file requirements are:
Include Page | ||||||
---|---|---|---|---|---|---|
|