Reorderer API - v0.5
- Anastasia Cheetham
This documentation refers to version 0.5 of the Reorderer code. For documentation specific to trunk, please see Reorderer API.
Reorderer Overview
The Reorderer will handle almost any arbitrary stream of markup you pass to it, assuming a very simple contract is maintained:
- The orderable elements are contained within some kind of container element.
- A selector for the container is passed to the Reorderer upon instantiation.
Optional:
- Provide a callback function. This will be called by the Reorderer each time the user reorders an element, and is generally used to communicate ordering changes back to the server.
- Specify configuration options to customize the behaviour of the Reorderer, including the selection of orderable elements within the container. These are documented below.
Join the fluid-talk mailing list and ask your questions there.
Creating a Reorderer
Lists
fluid.reorderList(container[, options]);
Allows reordering of elements in a vertical or horizontal list. More information is available at List Reorderer API - v0.5.
Grids
fluid.reorderGrid(container[, options]);
Allows reordering of a grid of items. More information is available at Grid Reorderer API - v0.5.
Layouts
fluid.reorderLayout(container[, options]);
Allows reordering of portlets, content blocks, or other chunks of layout arranged in columns. More information is available at Layout Reorderer API - v0.5.
Images
fluid.reorderImages(container[, options]);
Allows reordering of images, image thumbnails. More information is available at Image Reorderer API - v0.5.
Advanced use of the Reorderer
For cases where more control over the configuration of the Reorderer instance is needed, a Reorderer can be created directly, and configured for your specific needs:
fluid.reorderer(container[, options]);
For more information about these creator functions, see Advanced Reorderer API - v0.5.