Resortable - v2.1.5
    Preparing search index...

    Interface SortableEvents

    Mapping of event names to event payloads

    interface SortableEvents {
        start: SortableEvent;
        choose: SortableEvent;
        unchoose: SortableEvent;
        update: SortableEvent;
        sort: SortableEvent;
        end: SortableEvent;
        add: SortableEvent;
        remove: SortableEvent;
        select: Partial<SortableEvent>;
        move: MoveEvent;
        clone: SortableEvent;
        change: SortableEvent;
        spill: SortableEvent;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Allow additional custom events

    Index

    Properties

    Fired when drag starts

    Fired when an item is chosen for dragging

    unchoose: SortableEvent

    Fired when an item is unchosen (drag cancelled)

    Fired when an item is moved during drag

    A same-list duplicateKey drop fires this too, with pullMode: 'clone' and clone set. That is NOT a move: the handler must INSERT a copy at newIndex (newIndexes for multi-drag) and leave the original at oldIndex. Splicing the item out and back in — the usual onUpdate reorder — would lose the duplicate.

    Fired when sorting changes

    Also fires for a same-list duplicateKey drop — see update for why pullMode: 'clone' means insert-a-copy, not move.

    Fired when drag ends

    Fired on the list receiving an item from another list

    Fired on the list an item is dragged from when moved to another list

    select: Partial<SortableEvent>

    Fired when items are selected or deselected

    move: MoveEvent

    Fired during move operations

    Fired when an item is cloned

    Also fires for a duplicateKey drop. to === from on the event means an in-place (same-list) duplicate rather than a cross-zone copy.

    Fired when the sort order has changed

    Also fires for a same-list duplicateKey drop — see update for why pullMode: 'clone' means insert-a-copy, not move.

    Fired when an item is dropped outside all sortable containers