This page will walk you through an example of adding the Fluid Dropdown Inline Edit component to an HTML file. For more general information about the Dropdown Inline Edit API, see Dropdown Inline Edit API.
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.
You've created a database to keep track of your vast collection of CDs, and you're working on a web interface for it. When viewing the details of a CD, you would like to very easily categorize its genres. This tutorial will show you how to use the Fluid Dropdown Inline Edit for this.
There are four basic steps to adding the Inline Edit to your application:
- Step 1: Add the 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.
Let's assume that you're working with some HTML that displays the detailed information about a CD in your collection - something simple like this:
The simplest way to make the Genre appear as a dropdown selection is to do these three things:
- add a container for the options you want to make available
- specify your options and wrap it inside a
- specify which fragment of text on the screen will inherit the dropdown (in this example, the word "Triphop" will gain the dropdown)
- tell the Inline Edit about the container of these elements.
More specifically, we would:
- create a
selectionelement using the default class of
flc-inlineEdit-editand list the options you want to appear on the screen by using
- wrap the
selectinside a container using the default class of
- wrap the text that will gain the dropdown in a container using the default class
- finally, 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 script needed to instantiate the Inline Edit Dropdown component will look like this:
This function will look inside the element with the "albumGenre" ID (in this case, your
<dd> element) for anything with the
flc-inlineEditable class, and convert everything it finds into a Dropdown Inline Edit field with the appropriate options.
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 also be placed in a
<script> block at the end of your document.
You'll need to add the Fluid library and the jQuery Selectbox Plugin to you HTML file. Note that the jQuery selectbox plugin is currently found in the
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
jquery.selectbox.js files are everything you need.
So that's it! That's all you need to do to add the Dropdown 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.
The Dropdown Inline Edit component uses the jQuery selectbox plugin and currently requires the CSS that is shipped with the plugin. Note that right now this CSS is available in the
tests directory of the Fluid Infusion bundle. We can use the Fluid Skinning System (FSS) CSS skin files alongside the selectbox plugin CSS files.
and to attatch a class attribute that represents the skin you want to the components container, such as:
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.
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 page will look like this when the mouse hovers over the album genre: