Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISortableProps<T>

Type parameters

  • T

Hierarchy

  • Options
    • ISortableProps

Index

Properties

Optional animation

animation: number

ms, animation speed moving items when sorting, 0 — without animation

Optional chosenClass

chosenClass: string

Class name for the chosen item

Optional className

className: string

Optional dataIdAttr

dataIdAttr: string

Optional delay

delay: number

time in milliseconds to define when the sorting should start

Optional disabled

disabled: boolean

Disables the sortable if set to true.

Optional dragClass

dragClass: string

Class name for the dragging item

Optional draggable

draggable: string

Specifies which items inside the element should be draggable

Optional dragoverBubble

dragoverBubble: boolean

Optional dropBubble

dropBubble: boolean

Optional fallbackClass

fallbackClass: string

Class name for the cloned DOM Element when using forceFallback

Optional fallbackOffset

fallbackOffset: object

Type declaration

  • x: number
  • y: number

Optional fallbackOnBody

fallbackOnBody: boolean

Appends the cloned DOM Element into the Document's Body

Optional fallbackTolerance

fallbackTolerance: number

Specify in pixels how far the mouse should move before it's considered as a drag.

Optional filter

filter: string | function

Selectors that do not lead to dragging (String or Function)

Optional filterClass

filterClass: string

Optional forceFallback

forceFallback: boolean

ignore the HTML5 DnD behaviour and force the fallback to kick in

Optional ghostClass

ghostClass: string

Class name for the drop placeholder

Optional group

group: string | GroupOptions

To drag elements from one list into another, both lists must have the same group value. You can also define whether lists can give away, give and keep a copy (clone), and receive elements.

Optional handle

handle: string

Drag handle selector within list items

Optional ignore

ignore: string

Optional items

items: T[]

Optional onAdd

onAdd: function

Element is dropped into the list from another list

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onChange

onChange: function

Type declaration

    • (newItems: T[]): void
    • Parameters

      • newItems: T[]

      Returns void

Optional onChoose

onChoose: function

Element is chosen

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onClone

onClone: function

Created a clone of an element

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onEnd

onEnd: function

Element dragging ended

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onFilter

onFilter: function

Attempt to drag a filtered element

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onMove

onMove: function

Event when you move an item in the list or between lists

Type declaration

    • (event: MoveEvent): boolean
    • Parameters

      • event: MoveEvent

      Returns boolean

Optional onRemove

onRemove: function

Element is removed from the list into another list

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onSort

onSort: function

Called by any change to the list (add / update / remove)

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onStart

onStart: function

Element dragging started

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onUnchoose

onUnchoose: function

Element is unchosen

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional onUpdate

onUpdate: function

Changed sorting within list

Type declaration

    • (event: SortableEvent): void
    • Parameters

      • event: SortableEvent

      Returns void

Optional preventOnFilter

preventOnFilter: boolean

Call event.preventDefault() when triggered filter

Optional scroll

scroll: boolean

Optional scrollFn

scrollFn: function

if you have custom scrollbar scrollFn may be used for autoscrolling

Type declaration

    • (this: Sortable, offsetX: number, offsetY: number, event: MouseEvent): void
    • Parameters

      • this: Sortable
      • offsetX: number
      • offsetY: number
      • event: MouseEvent

      Returns void

Optional scrollSensitivity

scrollSensitivity: number

px, how near the mouse must be to an edge to start scrolling.

Optional scrollSpeed

scrollSpeed: number

px

Optional setData

setData: function

Type declaration

    • (dataTransfer: DataTransfer, draggedElement: HTMLElement): void
    • Parameters

      • dataTransfer: DataTransfer
      • draggedElement: HTMLElement

      Returns void

Optional sort

sort: boolean

sorting inside list

Optional store

store: object

Type declaration

  • get: function
      • (sortable: Sortable): string[]
      • Parameters

        • sortable: Sortable

        Returns string[]

  • set: function
      • (sortable: Sortable): void
      • Parameters

        • sortable: Sortable

        Returns void

Optional tag

tag: React.ComponentType | string

Generated using TypeDoc