Skip to content

Props

v-model

TypeDefaultRequired
Array | Ref[]true

The data that needs to be rendered

data-key

TypeDefaultRequired
String-true

The unique identifier of each piece of data, in the form of 'a.b.c'

keeps

TypeDefault
Number30

The number of lines rendered by the virtual scroll

size

TypeDefault
Number0

The estimated height of each piece of data, you can choose to pass it or not, it will be automatically calculated

handle

TypeDefault
String-

Drag handle selector within list items

group

TypeDefault
Object/String-
js
string: 'name'
object: {
  name: 'group',
  put: true/false,
  pull: true/false/'clone',
  revertDrag: true/false
}

tableMode

TypeDefault
Booleanfalse

Display with table

keepOffset

TypeDefault
Booleanfalse

When scrolling up to load data, keep the same offset as the previous scroll

direction

TypeDefault
vertical | horizontalvertical

Virtual list scroll direction

scroller

TypeDefault
Document | HTMLElementVirtual list wrap

Virtual list scrolling element

lockAxis

TypeDefault
x | y-

Axis on which dragging will be locked

debounceTime

TypeDefault
Number0

debounce time on scroll

throttleTime

TypeDefault
Number0

throttle time on scroll

sortable

TypeDefault
Booleantrue

Whether the current list can be sorted by dragging

disabled

TypeDefault
Booleanfalse

Disables the sortable if set to true

draggable

TypeDefault
String.virtual-dnd-list-item

Specifies which items inside the element should be draggable

itemClass

TypeDefault
Stringvirtual-dnd-list-item

Default list item class

animation

TypeDefault
Number150

Animation speed moving items when sorting

autoScroll

TypeDefault
Booleantrue

Automatic scrolling when moving to the edge of the container

scrollSpeed

TypeDefault
Object{ x: 10, y: 10 }

Vertical&Horizontal scrolling speed (px)

scrollThreshold

TypeDefault
Number55

Threshold to trigger autoscroll

delay

TypeDefault
Number0

Time in milliseconds to define when the sorting should start

delayOnTouchOnly

TypeDefault
Booleanfalse

Only delay on press if user is using touch

fallbackOnBody

TypeDefault
Booleanfalse

Appends the ghost element into the document's body

rootTag

TypeDefault
Stringdiv

Label type for root element

wrapTag

TypeDefault
Stringdiv

Label type for wrap element

wrapClass

TypeDefault
String-

List wrapper element class

wrapStyle

TypeDefault
Object{}

List wrapper element style

ghostClass

TypeDefault
String-

The class of the mask element when dragging

ghostStyle

TypeDefault
Object{}

The style of the mask element when dragging

chosenClass

TypeDefault
String-

Class name for the chosen item

placeholderClass

TypeDefault
String-

Class name for the drop placeholder

Released under the MIT License.