项目中遇到了不常开发的拖拽排序，使用后自己复盘一下，总结了两种拖拽排序的方法，适用于vue2，vue3。一种是利于元素自带的draggable原生拖拽，一种是使用插件，插件也适配移动设备
一、原生draggable拖拽方法
// html 部分
<div v-for="item in list" class="account-item" :draggable="true" @dragstart="dragstart(item)"
@dragenter="dragenter(item)" @dragend="dragend(item)">
<p>{{ item }}</p>
</div>
<script setup>
const list = ref(['1', '2', '3', '4', '5', '6'])
const clickVal = ref<string>();
const moveVal = ref<string>();
const endVal = ref<string>();
const dragstart = (item: string): void => {
clickVal.value = item
}
const dragenter = (item: string): void => {
moveVal.value = item
}
const dragend = (item: string): void => {
endVal.value = item;
let index = list.value.indexOf(item) //移动元素的当前位置
let moveObj = moveVal.value ? moveVal.value : ''
let addIndex = list.value.indexOf(moveObj) //要移动后的位置
list.value.splice(index, 1)
list.value.splice(addIndex, 0, item)
}
</script>
二、sortablejs插件方法
该插件功能很全，可以整个dom拖动，也可以按住item的某个按钮进行拖动，移动端也适用。官网
安装插件
npm i sortablejs --save
引入和使用
要在dom结构渲染完成后初始化插件，鼠标移动到排序按钮的时候提示“长按拖动排序”
其中做的时候对鼠标的移入移出事件也做了个复习。鼠标移动相关的有五个事件。
mousemove：当鼠标在一个节点内部移动时触发。当鼠标持续移动时，该事件会连续触发。为了避免性能问题，建议对该事件的监听函数做一些限定，比如限定一段时间内只能运行一次。
mouseenter：鼠标进入一个节点时触发，进入子节点不会触发这个事件。
mouseover：鼠标进入一个节点时触发，进入子节点会再一次触发这个事件。
mouseout：鼠标离开一个节点时触发，离开父节点也会触发这个事件。
mouseleave：鼠标离开一个节点时触发，离开父节点不会触发这个事件。
mouseover事件和mouseenter事件，都是鼠标进入一个节点时触发。两者的区别是，mouseenter事件只触发一次，而只要鼠标在节点内部移动，mouseover事件会在子节点上触发多次。
<template>
// v-if 会导致拿不到dom, 改成v-show可以解决
<div v-if="list.length" ref="dragcon" id="dragcon">
<div v-for="item in list" :key="item.id" class="account-item">
<p>{{ item }}</p>
<div class="sort-btn relative cursor-default" @mouseenter="tipEnter(item.id)" @mouseleave="tipShow = false">
<b>排序</b>
<span v-show="(tipShow && Number(tipId) === Number(item.id))">长按拖动排序</span>
</div>
</div>
</div>
<div v-else>暂无数据</div>
</template>
<script lang="ts" setup>
import Sortable from "sortablejs"
const tipId = ref(0)
const tipEnter = (id) => {
tipShow.value = true
tipId.value = id
}
const initSortable = () => {
const el = document.getElementById('dragcon')
// 创建拖拽实例
let dragTable = Sortable.create(el, {
animation: 150,
handle: ".sort-btn", // 触发拖动的按钮绑定类名sort-btn
dragClass: "sort-active",
chosenClass: "sort-active",
dataIdAttr: 'id',
// 结束拖动事件
onEnd: ({ newIndex, oldIndex }) => {
console.log(newIndex, oldIndex)
// 调后端接口。。。。。。
},
})
}
onMounted(async () => {
nextTick(() => {
initSortable()
})
})
</script>
遇到的问题
1、如果拖动不成功，或者拖动的不是你预计的item，浏览器审查元素，看看循环的item外面是不是结构不对，要对每个item进行拖拽，el用紧邻item外层的父级div，即v-for的外层。
2、另外不要用index作为v-for循环结构的key值，排序后若调接口查询list，渲染的时候会出问题。
3、另外el不能取div上有v-if的结构，可能会取不到dom结构，我偷懒，v-if改成了v-show可行，期待大佬提供其他方法。
sortablejs 插件的配置项
var sortable = new Sortable(el, {
group: "name", // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }
sort: true, // boolean 定义是否列表单元是否可以在列表容器内进行拖拽排序
delay: 0, // number 定义鼠标选中列表单元可以开始拖动的延迟时间；
touchStartThreshold: 0, // px, how many pixels the point should move before cancelling a delayed drag event
disabled: false, // boolean 定义是否此sortable对象是否可用，为true时sortable对象不能拖放排序等功能，为false时为可以进行排序，相当于一个开关；
store: null, // @see Store
animation: 150, // ms, number 单位：ms，定义排序动画的时间
easing: "cubic-bezier(1, 0, 0, 1)", // Easing for animation. Defaults to null. See https://easings.net/ for examples.
handle: ".my-handle", // 格式为简单css选择器的字符串，使列表单元中符合选择器的元素成为拖动的手柄，只有按住拖动手柄才能使列表单元进行拖动
filter: ".ignore-elements", // 过滤器，不需要进行拖动的元素
preventOnFilter: true, // 在触发过滤器`filter`的时候调用`event.preventDefault()`
draggable: ".item", // 允许拖拽的项目类名
ghostClass: "sortable-ghost", // drop placeholder的css类名
chosenClass: "sortable-chosen", // 被选中项的css 类名
dragClass: "sortable-drag", // 正在被拖拽中的css类名
dataIdAttr: 'data-id',
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', // 拖拽方向 (默认情况下会自动判断方向)
forceFallback: false, // 忽略 HTML5拖拽行为，强制回调进行
fallbackClass: "sortable-fallback", // 当使用forceFallback的时候，被复制的dom的css类名
fallbackOnBody: false, // 将cloned DOM 元素挂到body元素上。
fallbackTolerance: 0, // Specify in pixels how far the mouse should move before it's considered as a drag.
scroll: true, // or HTMLElement
scrollFn: function(offsetX, offsetY, originalEvent, touchEvt, hoverTargetEl) { ... }, // if you have custom scrollbar scrollFn may be used for autoscrolling
scrollSensitivity: 30, // px, how near the mouse must be to an edge to start scrolling.
scrollSpeed: 10, // px
bubbleScroll: true, // apply autoscroll to all parent elements, allowing for easier movement
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
setData: function (/** DataTransfer */dataTransfer, /** HTMLElement*/dragEl) {
dataTransfer.setData('Text', dragEl.textContent); // `dataTransfer` object of HTML5 DragEvent
},
// 元素被选中
onChoose: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// 元素未被选中的时候（从选中到未选中）
onUnchoose: function(/**Event*/evt) {
// same properties as onEnd
},
// 开始拖拽的时候
onStart: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// 结束拖拽
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.clone // the clone element
evt.pullMode; // when item is in another sortable: `"clone"` if cloning, `true` if moving
},
// 元素从一个列表拖拽到另一个列表
onAdd: function (/**Event*/evt) {
// same properties as onEnd
},
// 列表内元素顺序更新的时候触发
onUpdate: function (/**Event*/evt) {
// same properties as onEnd
},
// 列表的任何更改都会触发
onSort: function (/**Event*/evt) {
// same properties as onEnd
},
// 元素从列表中移除进入另一个列表
onRemove: function (/**Event*/evt) {
// same properties as onEnd
},
// 试图拖拽一个filtered的元素
onFilter: function (/**Event*/evt) {
var itemEl = evt.item; // HTMLElement receiving the `mousedown|tapstart` event.
},
// 拖拽移动的时候
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
},
// clone一个元素的时候触发
onClone: function (/**Event*/evt) {
var origEl = evt.item;
var cloneEl = evt.clone;
},
// 拖拽元素改变位置的时候
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
}
});