This documentation refers to version 0.5 of the Reorderer code. For documentation related trunk, please see Simple List Reorderer Tutorial
This page will walk you through an example of using the Fluid Reorderer's
reorderList() function to reorder a list in an HTML file.
This tutorial assumes that:
- you are familiar with what the List Reorderer is and does
- now you just want to know how to add it to your file.
Tutorial: How to Use the List Reorderer
You are organizing a small conference, and there is lots to do. Being the organized person you are, you create a to-do list. You'd like to use the Reorderer to allow the order of items to be changed. This tutorial will show you how to use the Fluid List Reorderer for this.
There are five basic steps to using the List Reorderer in your application:
- Step 1: Download and install the Fluid Infusion library
- Step 2: Prepare your markup
- Step 3: Write the script
- Step 4: Add the script to your HTML
- Step 5: 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 starting with an HTML file, called
todo-list.html, that contains an ordered list:
In a browser window, this might look something like this:
The List Reordeer needs to know about the 'container' of your list. In this case, that would be the
<ol> element. The Reorderer accepts a jQuery selector, so you can choose any method that will uniquely identify the
<ol> element. We'll attach a unique ID to it:
You also need to tell the Reorderer which of your list items should be reorderable. Perhaps the first item on your list, "Select the date," really needs to stay the first item, since everything else depends on the date. You don't want that item to be movable, so you can't just make every list item orderable.
You'll tell the Reorderer which items are to be orderable with another jQuery selector. Let's add a CSS class for that, say
That's all - these are the only changes you need to make to your HTML.
Step 2: Write the script
You'll need to create a file, say
todo-list.js, to contain your initialization script - the script you write to apply the Reorderer to your list.
In this file, write a function that calls the :
In this function call, the first parameter,
selectors, and we're using that options to provide a jQuery selector identifying elements with the CSS class "movable". That's all the information required by the
By enclosing the function call inside
jQuery(document).ready(), we ensure that the list is fully rendered before we apply the Reorderer to it.
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.
That's it! That's all you need to do to make your list reorderable!
Step 4: Apply styles
BUT: If you look at your file in a browser now, it doesn't look any different than it looked before - there's no way to tell that your list items are reorderable. That's what the styles are for.
There are a number of "interesting moments" that happen when dealing with a reorderable list. These include, for example, when the mouse hovers over a reorderable item, or when an item is selected using the keyboard. The Reorderer automatically applies CSS classes to the list items to mark these interesting moments. You can use these classes to define styles that inform users of the moments.
The CSS classes that are applied by the Reorderer, and the 'interesting moments' they are used for, are described below.
What: any item that is orderable
When: default state
Why: so that users can know that the item is orderable
Applied to the element that has been selected. The selected item can then be moved using keystrokes
Applied to an element while it is in the middle of being dragged
Applied to an element while the cursor is hovering over top of it
Applied to a clone of the dragged element that is carried around with the cursor while being dragged
Applied to an element that is created and used to indicate where the item will end up when it is dropped
It is also a good idea to set the padding for the lists. If no padding is set, the drop marker may be covered by the list elements
If we add a stylesheet with these styles (along with some global styles to make the font look a bit nicer, etc.), your list will look like this:
When you hover over an item, it will be apparent:
If you use the tab and arrow keys to select an item, you'll be able to tell:
And while you're dragging, you'll be able to tell where the drop will happen: