Vue component allowing drag-and-drop sorting in sync with View-Model. Based on Sortable.js
JavaScript
Latest commit 2800ee0 Jan 14, 2017 @David-Desmaisons David-Desmaisons committed on GitHub Merge pull request #62 from vmitchell85/patch-1
Remove typo and repeated text

README.md

Vue.Draggable

GitHub open issues GitHub closed issues Npm download Npm version Package Quality vue2 MIT License

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

Demo

demo gif

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
  • Cancelation support
  • Events reporting any changes when full control is needed

For Vue.js 2.0

Use draggable component:

Typical use:

<draggable :list="list" :options="{group:'people'}" @start="drag=true" @end="drag=false">
   <div v-for="element in list">{{element.name}}</div>
</draggable>

With transition-group:

<draggable :list="list"> 
    <transition-group>
        <div v-for="element in list" :key="element.id">
            {{element.name}}
        </div>
    </transition-group>
</draggable>

.vue file:

  import draggable from 'vuedraggable'
  ...
  export default {
        components: {
            draggable,
        },
    ...

Draggable component should directly wrap the draggable elements, or a transition-component containing the draggable elements.

Props

list

Type: Array
Required: false
Default: null

Array to be synchronized with drag-and-drop. Typically same array as referenced by inner element v-for directive.
When using children elements not linked to a "v-for" directive, use null.

options

Type: Object
Required: false

Option used to inicialize 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.

element

Type: String
Default: 'div'

HTML node type of the element that draggable component create as outer element for the included slot.

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 should be its cloned version.
By default vue.draggable reuse 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.

function onMoveCallback(evt, originalEvent){
   ...
    // return false; — for cancel
}

evt object has same property as Sortable onMove event, plus two additional properties:

  • draggedContext: context linked to dragged element
    • index: dragged element index
    • element: dragged element underlying view model element
  • relatedContext: context linked to current drag position
    • index: target element index
    • element: target element view model element
    • list: target list
    • component: 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

Events

  • Support for Sortable events:

    start, add, remove, update, end, choose, sort, filter, clone
    events are called when respectivelly onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onSort, onClone are fired by Sortabe.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 trigerred 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

Gotchas

  • Drag operation with empty list:

    To be abble to drag items on an empty draggable component, set a min-height>0 on the draggable component or the transition-group if any.

Fiddle

For Vue.js 1.0

See here

Installation

  • Available through:
 npm install vuedraggable
 Bower install vue.draggable
  • For Modules

    // ES6
    //For Vue.js 2.0
    import draggable from 'vuedraggable'
    ...
    export default {
          components: {
              draggable,
              ...
          }
          ...
    
    //For Vue.js 2.0
    var draggable = require('vuedraggable')
  • For <script> Include

    Just include Sortable.min.js and vuedraggable.min.js after Vue.