Input array to draggable component. Typically same array as referenced by inner element v-for directive.
This is the preferred way to use Vue.draggable as it is compatible with Vuex.
It should not be used directly but only though the v-model directive:
<draggablev-model="myArray">
list
Type: Array
Required: false
Default: null
Alternative to the value prop, list is an array to be synchronized with drag-and-drop.
The main difference is that list prop is updated by draggable component using splice method, whereas value is immutable. Do not use in conjunction with value prop.
All sortable options
New in version 2.19
Sortable options can be set directly as vue.draggable props since version 2.19.
This means that all sortable option are valid sortable props with the notable exception of all the method starting by "on" as draggable component expose the same API via events.
kebab-case propery are supported: for example ghost-class props will be converted to ghostClass sortable option.
Example setting handle, sortable and a group option:
HTML node type of the element that draggable component create as outer element for the included slot.
It is also possible to pass the name of vue component as element. In this case, draggable attribute will be passed to the create component.
See also componentData if you need to set props or event to the created component.
clone
Type: Function
Required: false
Default: (original) => { return original;}
Function called on the source component to clone element when clone option is true. The unique argument is the viewModel element to be cloned and the returned value is its cloned version.
By default vue.draggable reuses the viewModel element, so you have to use this hook if you want to clone or deep clone it.
move
Type: Function
Required: false
Default: null
If not null this function will be called in a similar way as Sortable onMove callback.
Returning false will cancel the drag operation.
functiononMoveCallback(evt,originalEvent){
...
// return false; — for cancel}
start, add, remove, update, end, choose, unchoose, sort, filter, clone
Events are called whenever onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onUnchoose, onSort, onClone are fired by Sortable.js with the same argument. See here for reference
Note that SortableJS OnMove callback is mapped with the move prop
HTML:
<draggable:list="list" @end="onEnd">
change event
change event is triggered when list prop is not null and the corresponding array is altered due to drag-and-drop operation.
This event is called with one argument containing one of the following properties:
added: contains information of an element added to the array
newIndex: the index of the added element
element: the added element
removed: contains information of an element removed from to the array
oldIndex: the index of the element before remove
element: the removed element
moved: contains information of an element moved within the array
newIndex: the current index of the moved element
oldIndex: the old index of the moved element
element: the moved element
Slots
Limitation: neither header or footer slot works in conjunction with transition-group.
Header
Use the header slot to add none-draggable element inside the vuedraggable component.
Important: it should be used in conjunction with draggable option to tag draggable element.
Note that header slot will always be added before the default slot regardless its position in the template.
Ex:
<draggablev-model="myArray" draggable=".item"><divv-for="element in myArray" :key="element.id" class="item">
{{element.name}}
</div><buttonslot="header" @click="addPeople">Add</button></draggable>
Footer
Use the footer slot to add none-draggable element inside the vuedraggable component.
Important: it should be used in conjunction with draggable option to tag draggable elements.
Note that footer slot will always be added after the default slot regardless its position in the template.
Ex:
<draggablev-model="myArray" draggable=".item"><divv-for="element in myArray" :key="element.id" class="item">
{{element.name}}
</div><buttonslot="footer" @click="addPeople">Add</button></draggable>
Gotchas
Vue.draggable children should always map the list or value prop using a v-for directive
You may use header and footer slot to by-pass this limitation.
Children elements inside v-for should be keyed as any element in Vue.js. Be carefull to provide revelant key values in particular:
typically providing array index as keys won't work as key should be linked to the items content
cloned elements should provide updated keys, it is doable using the clone props for example
SortableJS/Vue.Draggable
Vue.Draggable
Vue component (Vue.js 2.0) or directive (Vue.js 1.0) allowing drag-and-drop and synchronization with view model array.
Based on and offering all features of Sortable.js
For Vue 3
See vue.draggable.next
Demo
Live Demos
https://sortablejs.github.io/Vue.Draggable/
https://david-desmaisons.github.io/draggable-example/
Features
tag
andcomponentData
propsBackers
Looking for backers!
Donate
Find this project useful? You can buy me a☕ or a 🍺
Installation
With npm or yarn
Beware it is vuedraggable for Vue 2.0 and not vue-draggable which is for version 1.0
with direct link
cf example section
For Vue.js 2.0
Use draggable component:
Typical use:
.vue file:
With
transition-group
:Draggable component should directly wrap the draggable elements, or a
transition-component
containing the draggable elements.With footer slot:
With header slot:
With Vuex:
Props
value
Type:
Array
Required:
false
Default:
null
Input array to draggable component. Typically same array as referenced by inner element v-for directive.
This is the preferred way to use Vue.draggable as it is compatible with Vuex.
It should not be used directly but only though the
v-model
directive:list
Type:
Array
Required:
false
Default:
null
Alternative to the
value
prop, list is an array to be synchronized with drag-and-drop.The main difference is that
list
prop is updated by draggable component using splice method, whereasvalue
is immutable.Do not use in conjunction with value prop.
All sortable options
New in version 2.19
Sortable options can be set directly as vue.draggable props since version 2.19.
This means that all sortable option are valid sortable props with the notable exception of all the method starting by "on" as draggable component expose the same API via events.
kebab-case propery are supported: for example
ghost-class
props will be converted toghostClass
sortable option.Example setting handle, sortable and a group option:
tag
Type:
String
Default:
'div'
HTML node type of the element that draggable component create as outer element for the included slot.
It is also possible to pass the name of vue component as element. In this case, draggable attribute will be passed to the create component.
See also componentData if you need to set props or event to the created component.
clone
Type:
Function
Required:
false
Default:
(original) => { return original;}
Function called on the source component to clone element when clone option is true. The unique argument is the viewModel element to be cloned and the returned value is its cloned version.
By default vue.draggable reuses the viewModel element, so you have to use this hook if you want to clone or deep clone it.
move
Type:
Function
Required:
false
Default:
null
If not null this function will be called in a similar way as Sortable onMove callback. Returning false will cancel the drag operation.
evt object has same property as Sortable onMove event, and 3 additional properties:
draggedContext
: context linked to dragged elementindex
: dragged element indexelement
: dragged element underlying view model elementfutureIndex
: potential index of the dragged element if the drop operation is acceptedrelatedContext
: context linked to current drag operationindex
: target element indexelement
: target element view model elementlist
: target listcomponent
: target VueComponentHTML:
javascript:
See complete example: Cancel.html, cancel.js
componentData
Type:
Object
Required:
false
Default:
null
This props is used to pass additional information to child component declared by tag props.
Value:
props
: props to be passed to the child componentattrs
: attrs to be passed to the child componenton
: events to be subscribe in the child componentExample (using element UI library):
Events
Support for Sortable events:
start
,add
,remove
,update
,end
,choose
,unchoose
,sort
,filter
,clone
Events are called whenever onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onUnchoose, onSort, onClone are fired by Sortable.js with the same argument.
See here for reference
Note that SortableJS OnMove callback is mapped with the move prop
HTML:
change event
change
event is triggered when list prop is not null and the corresponding array is altered due to drag-and-drop operation.This event is called with one argument containing one of the following properties:
added
: contains information of an element added to the arraynewIndex
: the index of the added elementelement
: the added elementremoved
: contains information of an element removed from to the arrayoldIndex
: the index of the element before removeelement
: the removed elementmoved
: contains information of an element moved within the arraynewIndex
: the current index of the moved elementoldIndex
: the old index of the moved elementelement
: the moved elementSlots
Limitation: neither header or footer slot works in conjunction with transition-group.
Header
Use the
header
slot to add none-draggable element inside the vuedraggable component. Important: it should be used in conjunction with draggable option to tag draggable element. Note that header slot will always be added before the default slot regardless its position in the template. Ex:Footer
Use the
footer
slot to add none-draggable element inside the vuedraggable component. Important: it should be used in conjunction with draggable option to tag draggable elements. Note that footer slot will always be added after the default slot regardless its position in the template. Ex:Gotchas
Vue.draggable children should always map the list or value prop using a v-for directive
Children elements inside v-for should be keyed as any element in Vue.js. Be carefull to provide revelant key values in particular:
Example
Full demo example
draggable-example
For Vue.js 1.0
See here