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
- Full support of Sortable.js features:
- Supports touch devices
- Supports drag handles and selectable text
- Smart auto-scrolling
- Support drag and drop between different lists
- No jQuery dependency
- Keeps in sync HTML and view model list
- Compatible with Vue.js 2.0 transition-group
- Cancellation support
- Events reporting any changes when full control is needed
Use draggable component:
<draggable v-model="myArray" :options="{group:'people'}" @start="drag=true" @end="drag=false">
<div v-for="element in myArray">{{element.name}}</div>
</draggable>
.vue file:
import draggable from 'vuedraggable'
...
export default {
components: {
draggable,
},
...
<draggable v-model="myArray">
<transition-group>
<div v-for="element in myArray" :key="element.id">
{{element.name}}
</div>
</transition-group>
</draggable>
Draggable component should directly wrap the draggable elements, or a transition-component
containing the draggable elements.
<draggable v-model='myList'>
computed: {
myList: {
get() {
return this.$store.state.myList
},
set(value) {
this.$store.commit('updateList', 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:
<draggable v-model="myArray">
Type: Array
Required: false
Default: null
Altenative to the value
prop, list is an array to be synchronized with drag-and-drop.
The main diference is that list
prop is updated by draggable component using splice method, whereas value
is immutable.
Do not use in conjunction with value prop.
Type: Object
Required: false
Option used to initialize the sortable object see: sortable option documentation
Note that all the method starting by "on" will be ignored as draggable component expose the same API via events.
Type: String
Default: 'div'
HTML node type of the element that draggable component create as outer element for the included slot.
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.
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.
function onMoveCallback(evt, originalEvent){
...
// return false; โ for cancel
}
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 accepted
relatedContext
: context linked to current drag operationindex
: target element indexelement
: target element view model elementlist
: target listcomponent
: target VueComponent
HTML:
<draggable :list="list" :move="checkMove">
javascript:
checkMove: function(evt){
return (evt.draggedContext.element.name!=='apple');
}
See complete example: Cancel.html, cancel.js
-
Support for Sortable events:
start
,add
,remove
,update
,end
,choose
,sort
,filter
,clone
Events are called whenever onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onSort, onClone are fired by Sortable.js with the same argument.
See here for referenceNote 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 arraynewIndex
: the index of the added elementelement
: the added element
removed
: contains information of an element removed from to the arrayoldIndex
: the index of the element before removeelement
: the removed element
moved
: 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 element
-
Drag operation with empty list:
To be able to drag items on an empty draggable component, set a min-height more than 0 on the
draggable
component or thetransition-group
if any and ensure the transition group has display: block; otherwise height won't work.
-
Two Lists: https://jsfiddle.net/dede89/32ao2rpm/
-
Example with list clone: https://jsfiddle.net/dede89/t3m5krea/
-
Example with transition-group: https://jsfiddle.net/dede89/m2v0orcn/
-
Example with table: https://jsfiddle.net/dede89/L54yu3L9/
- Available through:
npm install vuedraggable
Bower install vue.draggable
-
// ES6 //For Vue.js 2.0 import draggable from 'vuedraggable' ... export default { components: { draggable, ... } ... //For Vue.js 2.0 var draggable = require('vuedraggable')
<!-- CDNJS :: Vue (https://cdnjs.com/) -->
<script src="//cdnjs.cloudflare.com/ajax/libs/vue/2.3.4/vue.min.js"></script>
<!-- CDNJS :: Sortable (https://cdnjs.com/) -->
<script src="//cdnjs.cloudflare.com/ajax/libs/Sortable/1.6.0/Sortable.min.js"></script>
<!-- CDNJS :: Vue.Draggable (https://cdnjs.com/) -->
<script src="//cdnjs.cloudflare.com/ajax/libs/Vue.Draggable/2.13.1/vuedraggable.min.js"></script>