This page is being upgraded to the new look and feel.

Production Status: PRODUCTION
The Inline Edit component 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 have some kind of container element.
  2. 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.

See Also

Inline Edit Component Description
Simple Text Inline Edit Component Description
Inline Edit API
Dropdown Inline Edit API
Rich Text Inline Edit API
Tutorial - Simple Text Inline Edit

About Infusion Components

 

Creator

fluid.inlineEdit(container, options)
Creates a single inline edit.

Supported Events

event
Event description

Methods

none

Options

listeners
See Supported Events for information

opt
Option description

opt
Option description

 

 

Creator

fluid.inlineEdits(container, options)
Creates an array of inline edit components.

Supported Events

event
Event description

Methods

none

Options

listeners
See Supported Events for information

opt
Option description

opt
Option description

Creators

back to top
Use the following function to create a single Simple Text Inline Edit component:

Method

fluid.inlineEdit(container, options);

Description

Instantiate a single Inline Edit component.

Parameters

container
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node of the Inline Edit markup.

options
An optional data structure that configures the Inline Edit component, as described below

Returns

The Inline Edit component

Examples

var myEdit = fluid.inlineEdit("#myContainer", {
    strings: {
        defaultViewText: "Edit here"
    }
});

Use the following function to create multiple Simple Text Inline Edit components:

Method

fluid.inlineEdits(container, options);

Description

Instantiate multiple Inline Edit components.

Parameters

container
A CSS-based selectors, single-element jQuery object, or DOM element that identifies the root DOM node where the UI Options interface should be placed.

options
An optional data structure that configures the Inline Edit components, as described below

Returns

An array of Inline Edit components

Examples

var myEditors = fluid.inlineEdits("#myContainer", {
    strings: {
        defaultViewText: "Edit here"
    }
});

Supported Events

back to top

Options

back to top

var myEdit = fluid.inlineEdit(".myContainer", {
    <option1Name>: <option1value>,
    <option2Name>: <option2value>
    ...
});

The options supported by Inline Edit are described below.

 

 

 




 

 

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 have some kind of container element.
  2. 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.


Creation

Creating a single Inline Edit

fluid.inlineEdit(componentContainer, options);

Return: The Inline Edit component object.

Creating Multiple Inline Edits

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.

This component is in Production status

Join the infusion-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.

options

The options parameter is an optional data structure that configures the Inline Edit component(s), as described below in the fluid:Options section.


Supported Events

The Inline Edit component fires the following events (for more information about events in the Infusion Framework, see Events):


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:

<link rel="stylesheet" type="text/css" href="components/inlineEdit/css/InlineEdit.css" />

Dependencies

The Inline Edit dependencies can be met by including the MyInfusion.js file in the header of the HTML file:

<script type="text/javascript" src="MyInfusion.js"></script>

Alternatively, the individual file requirements are: