/
Tutorial - Simple Text Inline Edit

Documentation for a historical release of Infusion: 1.3
Please view the Infusion Documentation site for the latest documentation.
If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

Tutorial - Simple Text Inline Edit

Aug 09, 2011

Step 1: Prepare your markup

The Changes

That's all - these are the only changes you need to make to your HTML.

* The editable text needs to be wrapped in its own element because this element will be hidden, and replaced with an edit field, when the text is edited. If, in your HTML, you already have an element wrapping your text (for example a <p> or a <div>), you could simply add the flc-inlineEdit-text class to that. In this example, we can't add the class to the <td> elements because you can't just hide a table cell and replace it with an edit field, can you? That wouldn't leave you with a valid table.

Step 2: Write the script

The script needed to instantiate the Inline Edit components will look like this:

jQuery(document).ready(function () { fluid.inlineEdits("#catalog-table"); });

This function will look inside the element with the "catalog-table" ID (in this case, your <table> element) for anything with the flc-inlineEditable class, and convert everything it finds into an Inline Edit field.

By putting the initialization function inside the jQuery(document).ready() call, you ensure that all of your markup is ready before you try to initialize the Inline Edit components.

This script can be placed in a <script> block at the end of your document.

Step 3: Add the Infusion library to your HTML

You'll need to add the Fluid library to you HTML file. In the header of the file, link to the Javascript files with <script> tags:

<script type="text/javascript" src="infusion-1.2/InfusionAll.js"></script>

NOTE that the InfusionAll.js file is minified - all of the whitespace has been removed, so it isn't really human-readable. If you're using the source distribution and you want to be able to debug the code, you'll want to include each of the required files individually. This would look like this:

But all of these individual files are not necessary to make it work - the InfusionAll.js file has everything you need.

So that's it! That's all you need to do to add the Inline Edit functionality to your table cells.

BUT: If you look at the file in a browser now, it doesn't look any different than it looked before - there's no way to tell that the album titles are editable. That's what the styles are for.

Step 4: Apply styles

The Inline Edit component can be skinned "out of the box" by including the component's CSS file:

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

If you wish to define your own styles instead, use the following information:

The Inline Edit adds classes to the display text element that can be used to style the element to let users know that the text is editable - that is, to make the functionality 'discoverable.' These classes are applied at various 'interesting moments,' for example when the cursor hovers over the editable text, or when Tab key is used to move focus to the text.

Important note

The visual appearance of the styles in the example below are just that: examples. You are free to create whatever styles you like. The important thing to understand is

  • what the interesting moments are, and

  • what the names of the styles for those moments are

Some of the styles that are applied by the Inline Edit, and the 'interesting moments' they are used for, are described below. For detailed information on all of the styles, see the Simple Text Inline Edit API page.

If we add a stylesheet with these styles, the table will look like this when the mouse hovers over the album titles: