onShowKeyboardDropWarning

default

This event fires before a drop warning is displayed.

item, kbDropWarning

item: The item being moved.
kbDropWarning: The DOM element that contains the drop warning, and that will be displayd.

onSelect

default

This event fires when an item is selected by the user.

item

item: The item being selected.

onBeginMove

"preventable"

This event fires just before a request to move is processed. Because the event is preventable, listeners may prevent the move from happening.

item

item: The item being moved.

onMove

default

This event fires just before an item is actually moved.

item, requestedPosition

item: The item being moved.
requestedPosition: An object describing the position that the user is trying to move the item into:

requestedPosition = {
    element, // the drop target
    position // the position, relative to the drop target,
             // that a dragged item should be dropped.
             // One of BEFORE, AFTER, INSIDE, or REPLACE
}

afterMove

default

This event fires after an item has successfully been moved. For more information, see Talking to the Server Using The afterMove Event

This event replaces the afterMoveCallbackUrl option, which was deprecated at version 1.1.2.

item, requestedPosition, movables

item: The item being moved.
requestedPosition: An object describing the position that the user is trying to move the item into:

requestedPosition = {
    element, // the drop target
    position // the position, relative to the drop target,
             // that a dragged item should be dropped.
             // One of BEFORE, AFTER, INSIDE, or REPLACE
}

movables: A list of all of the movable elements.

onHover

default

This event fires when the cursor moves over top of an item, and when the cursor moves away from an item. The default listener either adds or removes the hover class (styles.hover) to/from the item.

item, state

item: The item being moved.
state: A boolean indicating whether the cursor is moving to (true) or away from (false) the item.

onRefresh

default

This event fires any time the order of the items changes, or when the refresh() function is called.

none

columns

Identifies the DOM elements contained within the Layout Reorderer container that are themselves column containers, that is a container element that corresponds to a single column in the layout.

".flc-reorderer-column"

modules

Identifies the DOM elements contained within the Layout Reorderer container that are considered to be modules within the columns. Note that modules are assumed to be movable, unless they are identified by the lockedModules selector (see below).

".flc-reorderer-module"

lockedModules

Identifies the modules that should not be movable.

none

grabHandle

If present, identifies a single element within a module that the user must click on to drag the module.

""
(empty string)

dropWarning

Identifies a single element within the DOM that can be shown to display a warning when the user tries to move module where it can't be moved. It is assumed that this element contains whatever drop warning text and mark-up the implementor desires.

".flc-reorderer-dropWarning"

selectors

JavaScript object defining CSS-style selectors for important DOM elements. See Selectors for more information.

The object must be a list of objects containing any subset of the following keys:

  dropWarning
  movables
  selectables
  dropTargets
  grabHandle
  stylisticOffset

listeners

JavaScript object containing listeners to be attached to the supported events.

Keys in the object are event names, values are functions or arrays of functions.

See Supported Events

styles

an object containing CSS class names for styling the Reorderer.

The object may contain any of the keys defined in the default class names (shown to the right). Any class names not provided will revert to the default.

keysets

an object containing sets of keycodes to use for directional navigation, and for the modifier key used for moving a movable item.

The object must be a list of objects containing the following keys:
  modifier : a function that returns true or false, indicating whether or not the required modifier(s) are activated
  up
  down
  right
  left

avatarCreator

a function that returns a valid DOM node to be used as the dragging avatar

The item being dragged will be cloned

disableWrap

This option is used to disable wrapping of elements within the container.

boolean

false