Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Event

Type

Description

Parameters

Parameter Description

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 moved.

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:

Code Block
javascript
javascript
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 has been was deprecated as of 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:

Code Block
javascript
javascript
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