vuedragablefor

vue dragable for directive

Usage no npm install needed!

<script type="module">
  import vuedragablefor from 'https://cdn.skypack.dev/vuedragablefor';
</script>

README

Vue.Dragable.For

Vue directive for lists allowing drag-and-drop sorting in sync with View-Model. Based on Sortable.js

Motivation

Create a directive that displays a dragable list and keeps in sync the view and underlying view model.

Demo

demo gif

Simple:

https://jsfiddle.net/dede89/j62g58z7/

Two Lists:

https://jsfiddle.net/dede89/hqxranrd/

Example with list clone:

https://jsfiddle.net/dede89/u5ecgtsj/

Features

  • Full support of Sortable.js options via options parameters
  • Keeps in sync view model and view
  • No jquery dependency

Usage

Use it exactly as v-for directive, passing optional parameters using 'options' parameter. Option parameter can be json string or a full javascript object.

<div v-dragable-for="element in list1" options='{"group":"people"}'>
  <p>{{element.name}}</p>
</div>

Limitation

  • This directive works only when applied to arrays and not to objects.
  • onStart, onUpdate, onAdd, onRemove Sortable.js options hooks are used by v-dragable-for to update VM. As such these four options are not usable with v-dragable-for. If you need to listen to re-order events, you can watch the underlying view model collection. For example:
        watch: {
            'list1': function () {
                console.log('Collection updated!');
            },

Installation

  • Available through:
 npm install vuedragablefor

 Bower install vue.dragable.for

  • For Modules

    // ES6
import Vue from 'vue'
import VueDragableFor from 'vuedragablefor'
Vue.use(VueDragableFor)

// ES5
var Vue = require('vue')
Vue.use(require('vuedragablefor'))

  • For <script> Include

    Just include vue.dragable.for.js after Vue and lodash(version >=3).

License

MIT