...
The options parameter is an optional collection of name-value pairs that configure the Inline Edit component:
...
Name
...
Description
...
Values
...
Default
...
selectors
...
Javascript object containing selectors for various fragments of 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
tooltip
focus
Any values not provided will revert to the default.
...
styles: {
invitation: "inlineEdit-invitation",
defaultViewText: "inlineEdit-invitation-text",
tooltip: "inlineEdit-tooltip",
focus: "inlineEdit-focus"
}
...
paddings
...
Javascript object containing pixel 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 that returns an object of the following form:
...
return {
container: editContainer, // container element
// for the edit field
field: editField // the edit field itself
};
a function that creates the edit field based on the following template:
...
<span>
<input type='text'/>
</span>
...
selectOnEdit
...
Indicates whether or not to automatically select the editable text when the component switches into edit mode.
...
boolean
...
false
...
defaultViewText
...
The default text to use when filling in an empty component. Set to empty to suppress this behaviour
...
string
...
"Click here to edit"
...
useTooltip
...
Indicates whether or not the component should display a custom ("invitation") tooltip on mouse hover
...
boolean
...
false
...
tooltipText
...
The text to use for the tooltip to be displayed when hovering the mouse over the component
...
string
...
"Click item to edit"
...
tooltipId
...
The id to be used for the DOM node holding the tooltip
...
string
...
"tooltip"
...
tooltipDelay
...
The delay, in ms, between starting to hover over the component and showing the tooltip
...
number
...
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
...
Functions
| Code Block | ||||
|---|---|---|---|---|
| ||||
fluid.inlineEdit.edit(); |
...