Resortable - v3.1.0
    Preparing search index...

    Interface SortableEvent

    Event object passed to Sortable event callbacks

    This object contains information about the drag operation, including the affected elements and their positions.

    interface SortableEvent {
        item: HTMLElement;
        to: HTMLElement;
        from: HTMLElement;
        oldIndex?: number;
        newIndex?: number;
        oldDraggableIndex?: number;
        newDraggableIndex?: number;
        clone?: HTMLElement;
        pullMode?: boolean | "clone" | "move";
        items: HTMLElement[];
        oldIndexes?: number[];
        newIndexes?: number[];
    }

    Hierarchy (View Summary)

    Index
    item to from oldIndex? newIndex? oldDraggableIndex? newDraggableIndex? clone? pullMode? items oldIndexes? newIndexes?
    item: HTMLElement

    The dragged element

    to: HTMLElement

    The list that the element was dragged to

    from: HTMLElement

    The list that the element was dragged from

    oldIndex?: number

    Old index of the element (before drag)

    May be undefined for add/remove operations

    newIndex?: number

    New index of the element (after drag)

    May be undefined for add/remove operations

    oldDraggableIndex?: number

    Old index among draggable elements only

    Excludes non-draggable items from count

    newDraggableIndex?: number

    New index among draggable elements only

    Excludes non-draggable items from count

    clone?: HTMLElement

    Cloned element (when using group.pull: 'clone')

    Only present in clone operations

    pullMode?: boolean | "clone" | "move"

    Pull mode used for this operation

    • 'clone' when cloning
    • 'move' or true when moving
    • false or undefined for same-list operations

    On a clone event fired by duplicateKey, to === from marks an in-place (same-list) duplicate rather than a cross-zone copy.

    The end event reports the drag's outcome here too: 'clone' for any duplicate/clone drop (same-list or cross-zone), the source's pull mode for a cross-zone move, and undefined for a plain same-list reorder.

    items: HTMLElement[]

    Array of selected elements (multi-drag mode)

    oldIndexes?: number[]

    Per-item indices in from at drag start, parallel to items

    Only populated in controlled mode (see the controlled option). Named -Indexes deliberately — NOT legacy MultiDrag's misspelled oldIndicies.

    newIndexes?: number[]

    Per-item indices in to after the consumer commits the move, parallel to items (contiguous block starting at the drop index)

    Only populated in controlled mode (see the controlled option).

    Settings
    Member Visibility

    On This Page
    Properties