Wondering what‚Äôs next for npm?Check out our public roadmap! ¬Ľ

    @mrodrig/vuedraggable

    2.19.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    Vue.Draggable

    GitHub open issues npm download npm download per month 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

    Live Demo

    https://david-desmaisons.github.io/draggable-example/

    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 element and componentData props

    Backers

    Admin Dashboard Templates made with Vue, React and Angular.

    Installation

    With npm or yarn

    yarn add vuedraggable
     
    npm i -S vuedraggable

    Beware it is vuedraggable for Vue 2.0 and not vue-draggable which is for version 1.0

    with direct link

     
    <script src="//cdnjs.cloudflare.com/ajax/libs/vue/2.5.2/vue.min.js"></script>
    <!-- CDNJS :: Sortable (https://cdnjs.com/) -->
    <script src="//cdn.jsdelivr.net/npm/sortablejs@1.7.0/Sortable.min.js"></script>
    <!-- CDNJS :: Vue.Draggable (https://cdnjs.com/) -->
    <script src="//cdnjs.cloudflare.com/ajax/libs/Vue.Draggable/2.17.0/vuedraggable.min.js"></script>
     

    cf example section

    For Vue.js 2.0

    Use draggable component:

    Typical use:

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

    .vue file:

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

    With transition-group:

    <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.

    With footer slot:

    <draggable v-model="myArray" :options="{draggable:'.item'}">
        <div v-for="element in myArray" :key="element.id" class="item">
            {{element.name}}
        </div>
        <button slot="footer" @click="addPeople">Add</button>
    </draggable>

    With header slot:

    <draggable v-model="myArray" :options="{draggable:'.item'}">
        <div v-for="element in myArray" :key="element.id" class="item">
            {{element.name}}
        </div>
        <button slot="header" @click="addPeople">Add</button>
    </draggable>

    With Vuex:

    <draggable v-model='myList'>
    computed: {
        myList: {
            get() {
                return this.$store.state.myList
            },
            set(value) {
                this.$store.commit('updateList', value)
            }
        }
    }

    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:

    <draggable v-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.

    options

    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.

    As an example, a drag handle can be added using this binding :options="{handle:'.handle'}". Read the linked documentation for other options available to you.

    element

    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.

    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 element
      • index: dragged element index
      • element: dragged element underlying view model element
      • futureIndex: potential index of the dragged element if the drop operation is accepted
    • relatedContext: context linked to current drag operation
      • 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

    componentData

    Type: Object
    Required: false
    Default: null

    This props is used to pass additional information to child component declared by element props.
    Value:

    • props: props to be passed to the child component
    • on: events to be subscribe in the child component

    Example (using element UI library):

    <draggable element="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: {
        handleChange() {
          console.log('changed');
        },
        inputChanged(value) {
          this.activeNames = value;
        },
        getComponentData() {
          return {
            on: {
              change: this.handleChange,
              input: this.inputChanged
            },
            props: {
              value: this.activeNames
            }
          };
        }
      }

    Events

    • 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 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:

    <draggable v-model="myArray" :options="{draggable:'.item'}">
        <div v-for="element in myArray" :key="element.id" class="item">
            {{element.name}}
        </div>
        <button slot="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 element. Note that footer slot will always be added after the default slot regardless its position in the template. Ex:

    <draggable v-model="myArray" :options="{draggable:'.item'}">
        <div v-for="element in myArray" :key="element.id" class="item">
            {{element.name}}
        </div>
        <button slot="footer" @click="addPeople">Add</button>
    </draggable>

    Gotchas

    • Drag operation with empty list:

      To be able to drag items on an empty draggable component, set a min-height greater than 0 on the draggable component or the transition-group if any and ensure the transition group has display: block; otherwise height won't work.

    Fiddle

    ### Full demo example

    draggable-example

    For Vue.js 1.0

    See here

    Install

    npm i @mrodrig/vuedraggable

    DownloadsWeekly Downloads

    0

    Version

    2.19.0

    License

    MIT

    Unpacked Size

    30.3 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar