Draggable Components in Vue.js with Vue.Draggable

Published on April 23, 2017

Joshua Bemenderfer

Draggable Components in Vue.js with Vue.Draggable

While we believe that this content benefits our community, we have not yet thoroughly reviewed it. If you have any suggestions for improvements, please let us know by clicking the “report an issue“ button at the bottom of the tutorial.

Sortable lists are on of the more frustrating parts of web development. The web wasn’t originally created with drag-and-drop in mind, and even with the addition of native drag-and-drop support in HTML5, there’s still quite a bit to hook up. With Vue.Draggable however, this becomes a cinch. It makes most of the decisions for you and leaves a simple, clean API for your benefit.


Install Vue.Draggable from NPM or Yarn:

# Yarn
$ yarn add vuedraggable

$ npm install vuedraggable --save

Now, any component can import the draggable component from vuedraggable.


To make a list sortable, just wrap any element in a draggable component (usually with a v-for, but you can do individual elements as well.)

draggable can also take a v-model binding to update an array that contains the relevant data.

    <h2>Draggable Wrapper</h2>
    <draggable v-model="exampleList">
      <div v-for="text in exampleList" :key="text">{{text}}</div>

import draggable from 'vuedraggable';

export default {
  components: {

  data() {
    return {
      exampleList: [
        'Item 1',
        'Item 2',
        'Item 3',
        'Item 4',
        'Item 5'

Voilà! The list is sortable! You can drag and drop list items around however you’d like and the changes will be reflected in the array.

Props & Events


  • value (v-model capable): Array - The input array for the component. It’s immutable, so it’s recreated for every change.
  • list: Array - An alternative to value, but updates the array without recreating it. (via. Array.splice())
  • options: Object - An object containing any of the valid options for Sortable.
  • element: String - The wrapper element used by the draggable component. Defaults to div.
  • clone: Function(VNode) -> VNode - A method used to clone a VNode when the clone option is present. Fairly advanced. Mostly used for deep-cloning.
  • move: Function(evt) -> Boolean - Called when an element is dragged. Returning false will cancel the operation.

Events: start, add, remove, update, end, choose, sort, filter, clone. Reference

Usage with Vuex

When using Vue.Draggable with Vuex, use a computed property for your array that retrieves the array from the store via a getter, and commits a mutation when set:

computed: {
  exampleList: {
    get() {
      return this.$store.state.exampleList

    set(val) {
      this.$store.commit('setExampleList', val)


  • Vue.Draggable works fine with transitions, just make sure that the draggable element is directly wrapping the transition or transition-group element. There can be nothing else in-between.
  • If your list has 0 elements in it by default, make sure the element draggable creates is styled with enough height to be a valid drop target.

That’s all there is to it!

Now, I added home-spun drag-and-drop functionality to a couple personal projects. I’m going to go replace those shoddy implementations with Vue.Draggable now. Adiós!

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about our products

About the authors
Default avatar
Joshua Bemenderfer


Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
Leave a comment

This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

Featured on Community

Get our biweekly newsletter

Sign up for Infrastructure as a Newsletter.

Hollie's Hub for Good

Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.

Become a contributor

Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

Welcome to the developer cloud

DigitalOcean makes it simple to launch in the cloud and scale up as you grow — whether you're running one virtual machine or ten thousand.

Learn more
DigitalOcean Cloud Control Panel