Top Related Projects
Reorderable drag-and-drop lists for modern browsers and touch devices. No jQuery or framework required.
Beautiful and accessible drag and drop for lists with React
A set of higher-order components to turn any list into an animated, accessible and touch-friendly sortable list✌️
Drag and Drop for React
Infinite responsive, sortable, filterable and draggable layouts
Quick Overview
Vue.Draggable is a Vue component that wraps the SortableJS library, providing drag-and-drop functionality for Vue applications. It allows for easy implementation of sortable lists, grids, and other draggable elements within Vue projects.
Pros
- Seamless integration with Vue.js, making it easy to use in Vue applications
- Highly customizable with numerous options and events
- Supports both Vue 2 and Vue 3
- Lightweight and performant
Cons
- Learning curve for advanced features and configurations
- Limited documentation for complex use cases
- Occasional issues with nested draggable elements
- Dependency on the SortableJS library
Code Examples
- Basic sortable list:
<template>
<draggable v-model="myArray" item-key="id">
<template #item="{ element }">
<div>{{ element.name }}</div>
</template>
</draggable>
</template>
<script>
import draggable from 'vuedraggable'
export default {
components: {
draggable,
},
data() {
return {
myArray: [
{ id: 1, name: 'Item 1' },
{ id: 2, name: 'Item 2' },
{ id: 3, name: 'Item 3' },
],
}
},
}
</script>
- Drag handle and animation:
<template>
<draggable
v-model="myArray"
item-key="id"
handle=".handle"
:animation="200"
>
<template #item="{ element }">
<div>
<span class="handle">☰</span>
{{ element.name }}
</div>
</template>
</draggable>
</template>
- Two-way drag between lists:
<template>
<div class="row">
<draggable v-model="list1" :group="{ name: 'people', pull: 'clone', put: false }">
<template #item="{ element }">
<div>{{ element.name }}</div>
</template>
</draggable>
<draggable v-model="list2" :group="'people'">
<template #item="{ element }">
<div>{{ element.name }}</div>
</template>
</draggable>
</div>
</template>
Getting Started
-
Install the package:
npm install vuedraggable@next
-
Import and use in your Vue component:
<template> <draggable v-model="myList"> <template #item="{ element }"> <div>{{ element }}</div> </template> </draggable> </template> <script> import draggable from 'vuedraggable' export default { components: { draggable, }, data() { return { myList: ['Item 1', 'Item 2', 'Item 3'], } }, } </script>
Competitor Comparisons
Reorderable drag-and-drop lists for modern browsers and touch devices. No jQuery or framework required.
Pros of Sortable
- Framework-agnostic, can be used with any JavaScript project
- Lightweight and has fewer dependencies
- More flexible and customizable for complex sorting scenarios
Cons of Sortable
- Requires more manual setup and configuration for Vue.js projects
- Less intuitive integration with Vue.js reactive data and components
- May require additional code to handle Vue-specific reactivity
Code Comparison
Sortable:
import Sortable from 'sortablejs';
const el = document.getElementById('items');
const sortable = new Sortable(el, {
animation: 150,
ghostClass: 'blue-background-class'
});
Vue.Draggable:
<template>
<draggable v-model="myArray" group="people" @start="drag=true" @end="drag=false">
<div v-for="element in myArray" :key="element.id">{{ element.name }}</div>
</draggable>
</template>
<script>
import draggable from 'vuedraggable'
export default {
components: { draggable },
data() {
return { myArray: [...] }
}
}
</script>
Vue.Draggable is specifically designed for Vue.js, offering seamless integration with Vue's reactivity system and component structure. It provides a more declarative approach, making it easier to implement drag-and-drop functionality in Vue applications. However, Sortable offers greater flexibility and can be used in a wider range of projects, not limited to Vue.js.
Beautiful and accessible drag and drop for lists with React
Pros of react-beautiful-dnd
- Highly accessible, with built-in keyboard support and screen reader compatibility
- Smooth animations and intuitive drag and drop experience
- Extensive documentation and examples provided by Atlassian
Cons of react-beautiful-dnd
- Limited to vertical lists and horizontal lists, lacking support for grid layouts
- Specific to React ecosystem, not usable with other frameworks
- Larger bundle size compared to Vue.Draggable
Code Comparison
Vue.Draggable:
<draggable v-model="myArray">
<div v-for="element in myArray" :key="element.id">
{{ element.name }}
</div>
</draggable>
react-beautiful-dnd:
<DragDropContext onDragEnd={onDragEnd}>
<Droppable droppableId="list">
{(provided) => (
<div {...provided.droppableProps} ref={provided.innerRef}>
{myArray.map((item, index) => (
<Draggable key={item.id} draggableId={item.id} index={index}>
{(provided) => (
<div ref={provided.innerRef} {...provided.draggableProps} {...provided.dragHandleProps}>
{item.name}
</div>
)}
</Draggable>
))}
{provided.placeholder}
</div>
)}
</Droppable>
</DragDropContext>
A set of higher-order components to turn any list into an animated, accessible and touch-friendly sortable list✌️
Pros of react-sortable-hoc
- Built specifically for React, offering seamless integration with React components
- Provides more granular control over sorting behavior and animations
- Supports virtualized lists, improving performance for large datasets
Cons of react-sortable-hoc
- Steeper learning curve due to its more complex API
- Requires more setup and configuration compared to Vue.Draggable
- Less out-of-the-box functionality, may need additional libraries for certain features
Code Comparison
Vue.Draggable:
<draggable v-model="myArray">
<div v-for="element in myArray" :key="element.id">
{{ element.name }}
</div>
</draggable>
react-sortable-hoc:
const SortableItem = SortableElement(({value}) => <li>{value}</li>);
const SortableList = SortableContainer(({items}) => (
<ul>
{items.map((value, index) => (
<SortableItem key={`item-${index}`} index={index} value={value} />
))}
</ul>
));
The Vue.Draggable example shows a simpler implementation, while react-sortable-hoc requires more setup but offers more flexibility in how components are structured and sorted.
Drag and Drop for React
Pros of react-dnd
- More flexible and customizable for complex drag and drop scenarios
- Better integration with React ecosystem and state management
- Supports touch devices and accessibility out of the box
Cons of react-dnd
- Steeper learning curve and more boilerplate code required
- Less performant for simple drag and drop use cases
- Requires more setup and configuration
Code Comparison
react-dnd:
import { useDrag, useDrop } from 'react-dnd';
function DraggableItem({ id, text }) {
const [{ isDragging }, drag] = useDrag(() => ({
type: 'ITEM',
item: { id },
collect: (monitor) => ({
isDragging: monitor.isDragging(),
}),
}));
return <div ref={drag}>{text}</div>;
}
Vue.Draggable:
<template>
<draggable v-model="myArray" group="people" @start="drag=true" @end="drag=false">
<div v-for="element in myArray" :key="element.id">{{ element.name }}</div>
</draggable>
</template>
<script>
import draggable from 'vuedraggable';
export default {
components: { draggable },
// ...
}
</script>
The code comparison shows that react-dnd requires more setup and configuration, while Vue.Draggable offers a more declarative and simpler approach for basic drag and drop functionality.
Infinite responsive, sortable, filterable and draggable layouts
Pros of Muuri
- More flexible and powerful layout options, including grid and masonry layouts
- Better performance for large-scale applications with numerous items
- Supports multiple drag handles and nested grids
Cons of Muuri
- Steeper learning curve due to more complex API
- Less Vue-specific integration compared to Vue.Draggable
- Requires more setup and configuration for basic functionality
Code Comparison
Vue.Draggable:
<template>
<draggable v-model="myArray">
<div v-for="element in myArray" :key="element.id">{{ element.name }}</div>
</draggable>
</template>
Muuri:
<template>
<div ref="grid">
<div v-for="item in items" :key="item.id" class="item">{{ item.name }}</div>
</div>
</template>
<script>
import Muuri from 'muuri';
export default {
mounted() {
new Muuri(this.$refs.grid, { dragEnabled: true });
}
}
</script>
Vue.Draggable offers a more straightforward implementation for basic drag-and-drop functionality in Vue applications, while Muuri provides greater flexibility and power at the cost of increased complexity. Vue.Draggable is better suited for simpler use cases, whereas Muuri excels in more complex layout scenarios and larger-scale applications.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Vue.Draggable
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
For Vue 3
Demo
Live Demos
https://sortablejs.github.io/Vue.Draggable/
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
tag
andcomponentData
props
Backers
Looking for backers!
Donate
Find this project useful? You can buy me a :coffee: or a :beer:
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.8.4/Sortable.min.js"></script>
<!-- CDNJS :: Vue.Draggable (https://cdnjs.com/) -->
<script src="//cdnjs.cloudflare.com/ajax/libs/Vue.Draggable/2.20.0/vuedraggable.umd.min.js"></script>
For Vue.js 2.0
Use draggable component:
Typical use:
<draggable v-model="myArray" 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" 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" 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.
All sortable options
New in version 2.19
Sortable options can be set directly as vue.draggable props since version 2.19.
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.
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 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:
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 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: {
handleChange() {
console.log('changed');
},
inputChanged(value) {
this.activeNames = value;
},
getComponentData() {
return {
on: {
change: this.handleChange,
input: this.inputChanged
},
attrs:{
wrap: true
},
props: {
value: this.activeNames
}
};
}
}
Events
-
Support for Sortable events:
start
,add
,remove
,update
,end
,choose
,unchoose
,sort
,filter
,clone
Events are called whenever onStart, onAdd, onRemove, onUpdate, onEnd, onChoose, onUnchoose, onSort, onClone are fired by Sortable.js with the same argument.
See here for referenceNote 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 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:
<draggable v-model="myArray" 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 elements.
Note that footer slot will always be added after the default slot regardless its position in the template.
Ex:
<draggable v-model="myArray" 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
- Vue.draggable children should always map the list or value prop using a v-for directive
- Children elements inside v-for should be keyed as any element in Vue.js. Be carefull to provide revelant key values in particular:
- typically providing array index as keys won't work as key should be linked to the items content
- cloned elements should provide updated keys, it is doable using the clone props for example
Example
Full demo example
For Vue.js 1.0
Top Related Projects
Reorderable drag-and-drop lists for modern browsers and touch devices. No jQuery or framework required.
Beautiful and accessible drag and drop for lists with React
A set of higher-order components to turn any list into an animated, accessible and touch-friendly sortable list✌️
Drag and Drop for React
Infinite responsive, sortable, filterable and draggable layouts
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot