Interface SortableEvent

interface SortableEvent {
    AT_TARGET: 2;
    BUBBLING_PHASE: 3;
    CAPTURING_PHASE: 1;
    NONE: 0;
    bubbles: boolean;
    cancelBubble: boolean;
    cancelable: boolean;
    clone: HTMLElement;
    composed: boolean;
    currentTarget: null | EventTarget;
    defaultPrevented: boolean;
    eventPhase: number;
    from: HTMLElement;
    isTrusted: boolean;
    item: HTMLElement;
    newDraggableIndex: undefined | number;
    newIndex: undefined | number;
    newIndicies: {
        index: number;
        multiDragElement: HTMLElement;
    }[];
    oldDraggableIndex: undefined | number;
    oldIndex: undefined | number;
    oldIndicies: {
        index: number;
        multiDragElement: HTMLElement;
    }[];
    pullMode: undefined | boolean | "clone";
    returnValue: boolean;
    srcElement: null | EventTarget;
    swapItem: null | HTMLElement;
    target: HTMLElement;
    timeStamp: number;
    to: HTMLElement;
    type: string;
    composedPath(): EventTarget[];
    initEvent(type: string, bubbles?: boolean, cancelable?: boolean): void;
    preventDefault(): void;
    stopImmediatePropagation(): void;
    stopPropagation(): void;
}

Hierarchy

  • Event
    • SortableEvent

Properties

AT_TARGET BUBBLING_PHASE CAPTURING_PHASE NONE bubbles cancelBubble cancelable clone composed currentTarget defaultPrevented eventPhase from isTrusted item newDraggableIndex newIndex newIndicies oldDraggableIndex oldIndex oldIndicies pullMode returnValue srcElement swapItem target timeStamp to type

Methods

composedPath initEvent preventDefault stopImmediatePropagation stopPropagation

Properties

ReadonlyAT_TARGET

AT_TARGET: 2

ReadonlyBUBBLING_PHASE

BUBBLING_PHASE: 3

ReadonlyCAPTURING_PHASE

CAPTURING_PHASE: 1

ReadonlyNONE

NONE: 0

Readonlybubbles

bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

cancelBubble

cancelBubble: boolean

Deprecated

MDN Reference

Readonlycancelable

cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

clone

clone: HTMLElement

Readonlycomposed

composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

ReadonlycurrentTarget

currentTarget: null | EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

ReadonlydefaultPrevented

defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

ReadonlyeventPhase

eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

from

from: HTMLElement

previous list

ReadonlyisTrusted

isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

item

item: HTMLElement

dragged element

newDraggableIndex

newDraggableIndex: undefined | number

New index within parent, only counting draggable elements

newIndex

newIndex: undefined | number

new index within parent

newIndicies

newIndicies: {
    index: number;
    multiDragElement: HTMLElement;
}[]

When MultiDrag is used to sort, this holds a HTMLElement and newIndex for each item.

oldIndicies[number] is directly related to newIndicies[number]

If MultiDrag is not used to sort, this array will be empty.

oldDraggableIndex

oldDraggableIndex: undefined | number

Old index within parent, only counting draggable elements

oldIndex

oldIndex: undefined | number

old index within parent

oldIndicies

oldIndicies: {
    index: number;
    multiDragElement: HTMLElement;
}[]

When MultiDrag is used to sort, this holds a HTMLElement and oldIndex for each item selected.

oldIndicies[number] is directly related to newIndicies[number]

If MultiDrag is not used to sort, this array will be empty.

pullMode

pullMode: undefined | boolean | "clone"

Pull mode if dragging into another sortable

returnValue

returnValue: boolean

Deprecated

MDN Reference

ReadonlysrcElement

srcElement: null | EventTarget

Deprecated

MDN Reference

swapItem

swapItem: null | HTMLElement

When Swap is used to sort, this will contain the dragging item that was dropped on.

target

target: HTMLElement

Returns the object to which event is dispatched (its target).

MDN Reference

ReadonlytimeStamp

timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

to

to: HTMLElement

list, in which moved element.

Readonlytype

type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

Methods

composedPath

  • composedPath(): EventTarget[]

  • Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

    MDN Reference

    Returns EventTarget[]

initEvent

  • initEvent(type, bubbles?, cancelable?): void

  • Parameters

    • type: string
    • Optionalbubbles: boolean
    • Optionalcancelable: boolean

    Returns void

    Deprecated

    MDN Reference

preventDefault

  • preventDefault(): void

  • If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

    MDN Reference

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

  • Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

    MDN Reference

    Returns void

stopPropagation

  • stopPropagation(): void

  • When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

    MDN Reference

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods