# vue-draggable-next Vue 3 drag-and-drop component based on Sortable.js [Demo](https://vue-draggable-next.vercel.app/). ## Installation ``` npm install vue-draggable-next //or yarn add vue-draggable-next ``` ### Typical use: ```html ``` ### With `transition-group`: ```html

``` ### With Vuex: ```html ``` ```javascript computed: { myList: { get() { return this.$store.state.elements }, set(value) { this.$store.dispatch('updateElements', 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: ```html ``` #### 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](https://github.com/RubaXa/Sortable#options) 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: ```HTML ``` #### tag Type: `String`
Default: `'div'` HTML node type of the element that draggable component create as outer element. #### component Type: `String`
Default: `'null'` 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. #### componentData Type: `Function`
Required: `false`
Default: `null`
if you need to set props or attrs 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-next 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](https://github.com/RubaXa/Sortable#move-event-object). Returning false will cancel the drag operation. ```javascript function onMoveCallback(evt, originalEvent){ ... // return false; — for cancel } ``` evt object has same property as [Sortable onMove event](https://github.com/RubaXa/Sortable#move-event-object), 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: ```HTML ``` javascript: ```javascript checkMove: function(evt){ return (evt.draggedContext.element.name!=='apple'); } ``` ### 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 reference](https://github.com/RubaXa/Sortable#event-object-demo) HTML: ```HTML ``` - 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 ## 🌸 Thanks This project is heavily inspired by the following awesome vue 2 projects. - [SortableJS/Vue.Draggable](https://github.com/SortableJS/Vue.Draggable) Thanks!

Paquete	Descargas	Stars	Tamaño	Issues	Publicación	Licencia

vue-draggable-next	69,268	522	585 kB	17	hace 2 años	MIT