Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width60%
Info

This documentation refers to the latest trunk version of the Inline Edit code.

Inline Edit Overview

The 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:

  1. The elements that are part of the Inline Edit component are contained within some kind of container element.
  2. The text you wish to make editable is itself contained within an element inside 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.


Creating Multiple Inline Edits

Code Block
javascript
javascript
fluid.inlineEdits(componentContainerIdcomponentContainerSelector, options);

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#566b30
bgColor#fff
titleBGColor#D3E3C4
titleOn This Page
borderStylesolid
Table of Contents
minLevel2
maxLevel5
Panel
borderColor#321137
bgColor#fff
titleBGColor#c1b7c3
titleSee Also
borderStylesolid
Panel
borderColor#321137
bgColor#fff
titleBGColor#cccccc
titleStill need help?
borderStylesolid

Join the fluid-talk mailing list and ask your questions there.

Parameters

...

componentContainerSelector

The componentContainerId componentContainerSelector parameter is a selector identifying the ID of the root DOM node of the Inline Edit markup.

...

Code Block
javascript
javascript
fluid.inlineEdit(componentContainercomponentContainerSelector, options);

Return: The Inline Edit component object.

Parameters

componentContainer

The componentContainer componentContainerSelector parameter is a unique IDselector, jQuery object, or DOM element representing the component's container.

...