How to implement Sortable in Vuejs
Easily add drag-and-drop sorting to your Vue.js applications without jQuery, using the v-sortable directive.
Installation
|
1 |
npm install vue-sortable --save |
Usage
|
1 2 3 4 |
import Vue from 'vue' import Sortable from 'vue-sortable' Vue.use(Sortable) |
Basic Example
here we used v-sortable directive as attribute in ul tag
|
1 2 3 4 5 |
<ul class="list-group" v-sortable> <li class="list-group-item">Foo</li> <li class="list-group-item">Bar</li> <li class="list-group-item">Baz</li> </ul> |
Customization Example
here we set the object in v-sortable directive.
|
1 2 3 4 5 |
<ul class="list-group" v-sortable="{ handle: '.handle' }"> <li class="list-group-item">Foo <i class="handle"></i></li> <li class="list-group-item">Bar <i class="handle"></i></li> <li class="list-group-item">Baz <i class="handle"></i></li> </ul> |
If you need to pass multiple arguments, it can be cleaner to bind to an object from your VM data.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
<template> <ul class="list-group" v-sortable="options"> <li class="list-group-item">Foo <i class="handle"></i></li> <li class="list-group-item disabled">Bar <i class="handle"></i></li> <li class="list-group-item">Baz <i class="handle"></i></li> </ul> </template> <script> export default { data() { return { options: { handle: '.handle', filter: '.disabled' } } } } </script> |
The below implementation will update the order of the source data after an item is sorted using the sortable onUpdate callback.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
new Vue({ el: 'body', data: { list: ['Foo', 'Bar', 'Baz'] }, methods: { onUpdate: function (event) { this.list.splice(event.newIndex, 0, this.list.splice(event.oldIndex, 1)[0]) } } }); <ul v-sortable="{ onUpdate: onUpdate }"> <li v-for="item in list">{{ item }}</li> </ul> |
here are list of options which we can used in sortable.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
group: "name", // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] } sort: true, // sorting inside list delay: 0, // time in milliseconds to define when the sorting should start delayOnTouchOnly: false, // only delay if user is using touch touchStartThreshold: 0, // px, how many pixels the point should move before cancelling a delayed drag event disabled: false, // Disables the sortable if set to true. store: null, // @see Store animation: 150, // ms, animation speed moving items when sorting, `0` — without animation easing: "cubic-bezier(1, 0, 0, 1)", // Easing for animation. Defaults to null. See https://easings.net/ for examples. handle: ".my-handle", // Drag handle selector within list items filter: ".ignore-elements", // Selectors that do not lead to dragging (String or Function) preventOnFilter: true, // Call `event.preventDefault()` when triggered `filter` draggable: ".item", // Specifies which items inside the element should be draggable dataIdAttr: 'data-id', ghostClass: "sortable-ghost", // Class name for the drop placeholder chosenClass: "sortable-chosen", // Class name for the chosen item dragClass: "sortable-drag", // Class name for the dragging item swapThreshold: 1, // Threshold of the swap zone invertSwap: false, // Will always use inverted swap zone if set to true invertedSwapThreshold: 1, // Threshold of the inverted swap zone (will be set to swapThreshold value by default) direction: 'horizontal', // Direction of Sortable (will be detected automatically if not given) forceFallback: false, // ignore the HTML5 DnD behaviour and force the fallback to kick in fallbackClass: "sortable-fallback", // Class name for the cloned DOM Element when using forceFallback fallbackOnBody: false, // Appends the cloned DOM Element into the Document's Body fallbackTolerance: 0, // Specify in pixels how far the mouse should move before it's considered as a drag. dragoverBubble: false, removeCloneOnHide: true, // Remove the clone element when it is not showing, rather than just hiding it emptyInsertThreshold: 5, // px, distance mouse must be from empty sortable to insert drag element into it |
Callback methods of Sortable:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
setData: function (/** DataTransfer */dataTransfer, /** HTMLElement*/dragEl) { dataTransfer.setData('Text', dragEl.textContent); // `dataTransfer` object of HTML5 DragEvent }, // Element is chosen onChoose: function (/**Event*/evt) { evt.oldIndex; // element index within parent }, // Element is unchosen onUnchoose: function(/**Event*/evt) { // same properties as onEnd }, // Element dragging started onStart: function (/**Event*/evt) { evt.oldIndex; // element index within parent }, // Element dragging ended onEnd: function (/**Event*/evt) { var itemEl = evt.item; // dragged HTMLElement evt.to; // target list evt.from; // previous list evt.oldIndex; // element's old index within old parent evt.newIndex; // element's new index within new parent evt.oldDraggableIndex; // element's old index within old parent, only counting draggable elements evt.newDraggableIndex; // element's new index within new parent, only counting draggable elements evt.clone // the clone element evt.pullMode; // when item is in another sortable: `"clone"` if cloning, `true` if moving }, // Element is dropped into the list from another list onAdd: function (/**Event*/evt) { // same properties as onEnd }, // Changed sorting within list onUpdate: function (/**Event*/evt) { // same properties as onEnd }, // Called by any change to the list (add / update / remove) onSort: function (/**Event*/evt) { // same properties as onEnd }, // Element is removed from the list into another list onRemove: function (/**Event*/evt) { // same properties as onEnd }, // Attempt to drag a filtered element onFilter: function (/**Event*/evt) { var itemEl = evt.item; // HTMLElement receiving the `mousedown|tapstart` event. }, // Event when you move an item in the list or between lists onMove: function (/**Event*/evt, /**Event*/originalEvent) { // Example: https://jsbin.com/nawahef/edit?js,output evt.dragged; // dragged HTMLElement evt.draggedRect; // DOMRect {left, top, right, bottom} evt.related; // HTMLElement on which have guided evt.relatedRect; // DOMRect evt.willInsertAfter; // Boolean that is true if Sortable will insert drag element after target by default originalEvent.clientY; // mouse position // return false; — for cancel // return -1; — insert before target // return 1; — insert after target // return true; — keep default insertion point based on the direction // return void; — keep default insertion point based on the direction }, // Called when creating a clone of element onClone: function (/**Event*/evt) { var origEl = evt.item; var cloneEl = evt.clone; }, // Called when dragging element changes position onChange: function(/**Event*/evt) { evt.newIndex // most likely why this event is used is to get the dragging element's current index // same properties as onEnd } |
Was this post helpful?
Let us know if you liked the post. That’s the only way we can improve.
Yes0
No0
