VueDraggable Multi
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
Features
- 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
- Reuse existing UI library components (such as vuetify, element, or vue material etc...) and make them draggable using
tag
andcomponentData
props
Installation
npm i -S vuedraggable-multi
Typical use:
{{element.name}}
.vue file:
...components:draggable...
transition-group
:
With {{element.name}}
Draggable component should directly wrap the draggable elements, or a transition-component
containing the draggable elements.
With footer slot:
{{element.name}}Add
With header slot:
{{element.name}}Add
With Vuex:
computed: myList: { return this$storestatemyList } { this$store }
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, whereas value
is immutable.
Do not use in conjunction with value prop.
All sortable options
Sortable options can be set directly as vue.draggable props since
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:
<draggable v-model="list" handle=".handle" :group="{ name: 'people', pull: 'clone', put: false }" ghost-class="ghost" :sort="false" @change="log" > <!-- --></draggable>
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.
{ ... // 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:
{ return evtdraggedContextelementname!=='apple';}
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 component
Example (using element UI library):
<draggable tag="el-collapse" :list="list" :component-data="getComponentData()"> <el-collapse-item v-for="e in list" :title="e.title" :name="e.name" :key="e.name"> <div>{{e.description}}</div> </el-collapse-item></draggable>
methods: { console; } { thisactiveNames = value; } { return on: change: thishandleChange input: thisinputChanged attrs: wrap: true props: value: thisactiveNames ; }
multiDrag
Type: boolean
Required: false
Default: false
Set true
for activate MultiDrag plugin.
multiDragKey
Type: string
Required: false
Default: undefined
See "Selection key" part of MultiDrag plugin.
selectedClass
Type: string
Required: false
Default: undefined
The selected class is the HTML class that will be applied to the selected elements in the list.
Must set this prop for multi drag. (see MultiDrag plugin doc.)
Events
-
Support for Sortable events:
start
,add
,remove
,update
,end
,choose
,unchoose
,sort
,filter
,clone
,select
,deselect
Events are called whenever onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onUnchoose, onSort, onClone, onSelect, onDeselect are fired by Sortable.js with the same argument.
See here for reference and see here for MultiDrag reference
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
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:
{{element.name}}Add
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:
{{element.name}}Add