Class sortablejs

constructor

• new sortablejs(element, options): sortablejs

• Sortable's main constructor.

  Parameters

  • element: HTMLElement

    Any variety of HTMLElement.
  • options: sortablejs.Options

    Sortable options object.

  Returns sortablejs

el

options

Staticactive

Staticclone

Staticdragged

Staticghost

Staticutils

Static Readonlyversion

closest

• closest(element, selector?): null | HTMLElement

• For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.

  Parameters

  • element: HTMLElement

    an HTMLElement or selector string.
  • Optionalselector: string

    default: options.draggable

  Returns null | HTMLElement

destroy

• destroy(): void

• Removes the sortable functionality completely.

  Returns void

option

• option<K>(name, value): void

• Options getter/setter

  Type Parameters

  • K extends keyof sortablejs.Options

  Parameters

  • name: K

    a Sortable.Options property.
  • value: sortablejs.Options[K]

    a value.

  Returns void
• option<K>(name): sortablejs.Options[K]

• Type Parameters

  • K extends keyof sortablejs.Options

  Parameters

  • name: K

  Returns sortablejs.Options[K]

save

• save(): void

• Saving and restoring of the sort.

  Returns void

sort

• sort(order): void

• Sorts the elements according to the array.

  Parameters

  • order: readonly string[]

    an array of strings to sort.

  Returns void

toArray

• toArray(): string[]

• Serializes the sortable's item data-id's (dataIdAttr option) into an array of string.

  Returns string[]

Staticcreate

• create(element, options?): sortablejs

• Creation of new instances.

  Parameters

  • element: HTMLElement

    Any variety of HTMLElement.
  • Optionaloptions: sortablejs.Options

    Sortable options object.

  Returns sortablejs

Staticget

• get(element): undefined | sortablejs

• Get the Sortable instance on an element.

  Parameters

  • element: HTMLElement

  Returns undefined | sortablejs

Staticmount

• mount(...sortablePlugins): void

• Mounts a plugin to Sortable

  Parameters

  • Rest...sortablePlugins: SortablePlugin[]

  Returns void

  Example

  Sortable.mount(new MultiDrag(), new AutoScroll())
  Copy