This documentation refers to version 0.5 of the Inline Edit code. For documentation specific to trunk, please see Simple Text Inline Edit Tutorial
This tutorial assumes that:
- you are familiar with what the Inline Edit is and does
- now you just want to know how to add it to your file.
Tutorial: How to Use the Inline Edit
You've created a database to keep track of your vast collection of CDs, and you're working on a web interface for it. You'd like to be able to very easily edit the information on the page. This tutorial will show you how to use the Fluid Inline Edit for this.
There are four basic steps to adding the Inline Edit to your application:
- Step 0: Download and install the Fluid Infusion library
- Step 1: Prepare your markup
- Step 2: Write the script
- Step 3: Add the script to your HTML
- Step 4: Apply styles
The rest of this tutorial will explain each of these steps in detail.
Step 0: Download and install the Fluid Infusion library
- Download a copy of the Fluid Infusion component library from:
You only really need the "Minified deployment package," but if you want to actually look at the code, you should download the "Source package."
- Unpack the zip file you just downloaded, and place the resulting folder somewhere convenient for your development purposes.
The folder will have the release number in it's name (e.g.
fluid-0.4/). The rest of this tutorial will use
fluid-0.4in its examples, but if you downloaded a different version, you'll have to adjust.
Step 1: Prepare your markup
Let's assume that you're working with some HTML that displays the information about your collection - something simple like this:
In a browser window, this might look something like this:
The simplest way to make many pieces of text editable requires you to do three things:
- mark the elements you want to be editable with a particular CSS class, "
- wrap the actual editable text with an element * with a CSS class of "
- tell the Inline Edit about the container of these elements.
If we want to make, say, all of the album titles editable, then we could
- add the "
inlineEditable" class to those
- wrap the text in those
<td>elements in a
<span>* with the
- place a unique ID on the
This might look like the HTML sample to the right.
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
text class to that.
Step 2: Write the script
You'll need to create a file, say
catalog.js, to contain your initialization script - the script you write to apply the Inline Edit to your album titles.
In this file, write a function that invokes the
This function will look inside the element with the "catalog-table" ID (in this case, your
<table> element) for anything with the
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.
Step 3: Add the script to your HTML
NOTE that the
Fluid-all.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
Fluid-all.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 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.
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
The styles that are applied by the Inline Edit, and the 'interesting moments' they are used for, are:
When: mouse hover and keyboard focus
Why: so that users can know that the text is editable
When: keyboard focus on the text
Why: so that users know that focus is on the text, and that they can press Enter to start editing
If we add a stylesheet with these styles, the table will look like this when the mouse hovers over the album titles: