| Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
options
The options parameter is an optional collection of name-value pairs that configure the Inline Edit components. The available options are described below, with the addition of a selector for identifying the editable elements. The default selector is defined as follows:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| javascript | javascript |
selectors: {
editables: "
|
Constructor
...
fluid.InlineEdit(componentContainer, options);
Parameters
componentContainer
The componentContainer parameter is a unique ID, jQuery objectselector, a single-element jQuery, or a DOM element representing the component's containerspecifying 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
...
Supported Events
The Inline Edit component
...
The object can contain any subset of the following keys:
text
editContainer
edit
Any values not provided will revert to the default.
...
selectors: {
text: ".text",
editContainer: ".editContainer",
edit: ".edit"
}
...
styles
...
Javascript object containing CSS style names that will be applied to the Inline Edit component.
...
The object can contain any subset of the following keys:
invitation
defaultViewText
focus
Any values not provided will revert to the default.
...
styles: {
invitation: "invitation",
defaultViewText: "invitation-text",
focus: "focus"
}
...
paddings
...
Javascript object containing pixed values that will configure the size of the edit field.
...
The object can contain any subset of the following keys:
edit
minimumEdit
minimumView
Any values not provided will revert to the default.
...
paddings: {
edit: 10,
minimumEdit: 80,
minimumView: 60
}
...
finishedEditing
...
A function that will be called each time the Inline Edit component leaves edit mode. This function can be used to communicate changes in the field to the server, or to take any other action desired by the implementor.
...
a function
...
finishedEditing: function () {
}
...
editModeInjector
...
A function that creates the editable field based on the display text. This function is used if no edit container is provided in the markup.
...
a function
...
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 |
...
/ |
...
selectOnEdit
...
Indicates whether or to automatically selected the editable text when the component switches into edit mode.
...
boolean
...
false
...
useDefaultViewText
...
Indicates whether or not the component should be filled in with default text when empty.
...
boolean
...
true
...
defaultViewText
...
The default text to use when filling in an empty component.
...
String
...
"Click here to edit"
Functions
...
fluid.InlineEdit.edit();
Switches the component into edit mode.
...
fluid.InlineEdit.finish();
...
javascript" src="InfusionAll.js"></script>
|
Alternatively, the individual file requirements are:
| Include Page | ||||||
|---|---|---|---|---|---|---|
|