Child pages
  • Tutorial - Simple Text Inline Edit

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{section}
{column:width=60%}
This page will walk you through an example of adding the Fluid [Inline Edit] component to an HTML file. For more general information about the Inline Edit API, see [Simple Text Inline Edit API].

This tutorial assumes that:
* you are already familiar with HTML, Javascript and CSS
* you are familiar with what the Inline Edit is and does
* now you just want to know how to add it to your file.

h1. Tutorial: How to Use the Inline Edit


h2. Scenario

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:
* Setup: Download and install the Fluid Infusion library
* Step 1: Prepare your markup
* Step 2: Write the script
* Step 3: Add the Fluid library to your HTML
* Step 4: Apply styles

The rest of this tutorial will explain each of these steps in detail.
{column}
{column}
{panel:title= On This Page| borderStyle=solid| borderColor=#566b30| titleBGColor=#D3E3C4| bgColor=#fff}
{toc:minLevel=2|maxLevel=2}
{panel}
{panel:title=See Also|borderStyle=solid|borderColor=#321137|titleBGColor=#c1b7c3|bgColor=#fff}
* [Inline Edit]
* [Simple Text Inline Edit API]
{panel}
{panel:title=Still need help?|borderStyle=solid|borderColor=#321137|titleBGColor=#cccccc|bgColor=#fff}
Join the [infusion-users mailing list|http://fluidproject.org/mailman/listinfo/infusion-users] and ask your questions there.
{panel}
{column}
{section}

----
h2.
Setup{include: Download and install the Fluid Infusion library

# Download a copy of the Fluid Infusion component library from:
#* http://fluidproject.org/products/fluid-infusion/download-infusion/
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. {{infusion-1.0/}}). The rest of this tutorial will use {{infusion-1.0}} in its examples, but if you downloaded a different version, you'll have to adjust.

----Tutorial Setup}

----
h2. Step 1: Prepare your markup

{section}
{column}
Let's assume that you're working with some HTML that displays the information about your collection - something simple like this:
{code:html}
<table>
  <tr>
    <th>Artist</th>
    <th>Album</th>
    <th>Year</th>
  </tr>
  <tr>
    <td>Bootsy Collins</td>
    <td>Ultra Wave</td>
    <td>1980</td>
  </tr>
  <tr>
    <td>New York Dolls</td>
    <td>One Day It Will Please Us To Remember Even This</td>
    <td>2006</td>
  </tr>
  ...
</table>
{code}
{column}
{column}
In a browser window, this might look something like this:

!inline-edit-1.jpeg!
{column}
{section}

h3. The Changes

{section}
{column}
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 the default CSS selector class, "{{flc-inlineEditable}}"
# wrap the actual editable text with an element {color:red}\*{color} with a CSS class of "{{text}}"
# 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 "{{flc-inlineEditable}}" class to those {{<td>}} elements
# wrap the text in those {{<td>}} elements in a {{<span>}} {color:red}\*{color} with the {{text}} class
# place a unique ID on the {{<table>}} element.

This might look like the HTML sample to the right.
{column}
{column}
{code:html}
<table id="catalog-table">
  <tr>
    <th>Artist</th>
    <th>Album</th>
    <th>Year</th>
  </tr>
  <tr>
    <td>Bootsy Collins</td>
    <td class="flc-inlineEditable">
      <span class="flc-inlineEdit-text">Ultra Wave</span>
    </td>
    <td>1980</td>
  </tr>
  <tr>
    <td>New York Dolls</td>
    <td class="flc-inlineEditable">
      <span class="flc-inlineEdit-text">One Day It Will Please Us
                         To Remember Even This</span>
    </td>
    <td>2006</td>
  </tr>
  ...
</table>
{code}
{column}
{section}
That's all - these are the only changes you need to make to your HTML.

{color:red}\*{color} 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. 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}}.

----
h2. Step 2: Write the script

The script needed to instantiate the Inline Edit components will look like this:
{code:javascript}
jQuery(document).ready(function () {
    fluid.inlineEdits("#catalog-table");
});
{code}
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.
----
h2. Step 3: Add the Fluid 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:
{code:html}
<script type="text/javascript" src="infusion-1.0/InfusionAll.js"></script>
{code}
{color:red}NOTE{color} 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:
{code:html}
<script type="text/javascript" src="infusion-1.0/lib/jquery/core/js/jquery.js"></script>
<script type="text/javascript" src="infusion-1.0/lib/jquery/ui/js/ui.core.js"></script>
<script type="text/javascript" src="infusion-1.0/framework/core/js/jquery.keyboard-a11y.js"></script>
<script type="text/javascript" src="infusion-1.0/framework/core/js/Fluid.js"></script>
<script type="text/javascript" src="infusion-1.0/components/inlineEdit/js/InlineEdit.js"></script>
{code}
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.

{color:red}BUT{color}: 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.

----
h2. Step 4: Apply styles

The Inline Edit component can be skinned "out of the box" by including the [Fluid Skinning System (FSS)] CSS skin files. Just be sure to put the following in you document:

{code:html}
<link rel="stylesheet" type="text/css" href="framework/fss/css/fss-layout.css" />
<link rel="stylesheet" type="text/css" href="framework/fss/css/fss-theme.mist.css" />
<link rel="stylesheet" type="text/css" href="framework/fss/css/fss-theme.hc.css" />
<link rel="stylesheet" type="text/css" href="components/inlineEdit/css/InlineEdit.css" />
{code}

and to attatch a class attribute that represents the skin you want to the components container, such as:

{code:html}
<div id="catalog-table" class="fl-theme-mist">
    ...
</div>
{code}

The above code would make use of the {{fss-theme.mist.css}} skin file.

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.
{note:title=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
{note}
The styles that are applied by the Inline Edit, and the 'interesting moments' they are used for, are:
{section}
{column:width=50%}
*Style:* "fl-inlineEdit-invitation"
*When:* mouse hover and keyboard focus
*Why:* so that users can know that the text is editable
{column}
{column}
Sample style:
{code}
.fl-inlineEdit-invitation {
   background-color: #FFECB3 !important;
   border: 1px solid #CCC !important;
}
{code}
{column}
{section}
{section}
{column:width=50%}
*Style:* "fl-inlineEdit-focus"
*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
{column}
{column}
Sample style:
{code}
.fl-inlineEdit-focus {
    border: 2px solid #777777;
}
{code}
{column}
{section}
If we add a stylesheet with these styles, the table will look like this when the mouse hovers over the album titles:
{center} !inline-edit-2.jpeg!
{center}

----