Section |
---|
Column |
---|
| Info | This documentation refers to the latest trunk version of the Inline Edit code.OverviewThe Inline Edit OverviewAllow allows users to edit content within the context of their work rather than going to an "edit mode". Constructor. It can be applied to any text, assuming a very simple contract is maintained: - The elements that are part of the Inline Edit component have some kind of container element.
- The text you wish to make editable is within the component container.
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 Code Block |
---|
|
fluid.InlineEditinlineEdit(componentContainerIdcomponentContainer, options);
|
ParameterscomponentContainerIdThe componentContainerId parameter is the ID of the root DOM node of the Inline Edit markupReturn: The Inline Edit component object. Creating Multiple Inline Edits Code Block |
---|
|
fluid.inlineEdits(componentContainer, options);
|
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. |
Column |
---|
Panel |
---|
borderColor | #321137 |
---|
bgColor | #fff |
---|
titleBGColor | #aab597 |
---|
borderStyle | solid |
---|
title | Status |
---|
| This component is in Production status |
Panel |
---|
borderColor | #566b30 |
---|
bgColor | #fff |
---|
titleBGColor | #D3E3C4 |
---|
borderStyle | solid |
---|
title | On This Page | borderStyle
---|
| | solid |
Panel |
---|
borderColor | #321137 |
---|
bgColor | #fff |
---|
titleBGColor | #c1b7c3 |
---|
borderStyle | solid |
---|
title | See Also |
---|
borderStyle | solid |
---|
|
| |
Panel |
---|
borderColor | #321137 |
---|
bgColor | #fff |
---|
titleBGColor | #cccccc |
---|
borderStyle | solid |
---|
title | Still need help? | borderStyle | solid |
---|
| Join the fluidinfusion-talk users mailing list and ask your questions there. |
|
|
Parameters
componentContainer
The componentContainer
parameter is a selector, a single-element jQuery, or a DOM element specifying the root DOM node of the Inline Edit markup.
Anchor |
---|
| option_description |
---|
| option_description |
---|
|
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.
...
...
...
...
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
...
...
...
function () {}
Functions
...
fluid.InlineEdit.edit();
Switches the component into edit mode.
...
fluid.InlineEdit.finish();
...
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 |
---|
| Inline Edit Events |
---|
| Inline Edit Events |
---|
|
Include Page |
---|
| Inline Edit Functions |
---|
| Inline Edit Functions |
---|
|
Include Page |
---|
| Inline Edit Configuration Options |
---|
| Inline Edit Configuration Options |
---|
nopanel | true |
---|
|
...
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 |
---|
| Inline Edit Dependencies |
---|
| Inline Edit Dependencies |
---|
nopanel | true |
---|
|