Page Operations
Browse Space
| 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: { |
| listeners | JavaScript object containing listeners to be attached to the supported events. | Keys in the object are event names, values are functions or arrays of functinos. | See Supported Events |
| 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: { |
| 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: { |
| finishedEditing DEPRECATED |
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. NOTE that this function is deprecated as of version 0.6. It will be removed entirely in version 0.9. |
a function | undefined |
| editModeRenderer | 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 { where editContainer is a container element for the edit field itself and editField is the edit field itself. |
a function that creates the edit field based on the following template:
<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 | 2000 |
|
|
|
|||