| Section |
|---|
| Column |
|---|
| | Info |
|---|
This documentation refers to the latest trunk version of the Inline Edit code. For documentation specific to a particular release, please see Previous Versions of API Documents. |
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: - 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.inlineEdit(componentContainer, options);
|
Return: 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 infusion-users mailing list and ask your questions there. |
|
|
...
|
| Code Block |
|---|
javascript | javascript |
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.
Parameters
componentContainer
...
The options parameter is an optional data structure that configures the Inline Edit component(s), as described below in the fluid:Options section.
...
...
The Inline Edit component fires the following events (for more information about events in the Fluid Framework, see Events for Component Users):
| Include Page |
|---|
| Infusion13:Inline Edit EventsInfusion13: |
|---|
| Inline Edit Events |
|---|
|
| Include Page |
|---|
| Infusion13:Inline Edit FunctionsInfusion13: |
|---|
| Inline Edit Functions |
|---|
|
| Include Page |
|---|
| Infusion13:Inline Edit Configuration OptionsInfusion13: |
|---|
| 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 |
|---|
| Infusion13:Inline Edit Dependencies |
|---|
| nopanel | true |
|---|
|