vue-element el-table 使用sortablejs拖拽排序

需求描述

vue-element-admin开发过程中需要对el-table行进行排序（即每一行可以上下移动），然后将排序后的数据传给后台更新数据。该表格无分页。

问题分析

方法一：可以采用在每条数据中加两个上下移动的按钮，每次移动一行。该方法实现简单，不过要连续移动的时候需要多次调用接口，交互效果不太好。

方法二：可以采用table的拖拽功能实现行的一次性拖拽。该方法可以实现拖拽后调用接口，任意移动多行，但是需要依赖sortablejs仓库。

问题解决

综合考虑决定使用sortablejs实现该功能。

• 安装依赖

npm install sortablejs --save
# yarn add sortablejs --save
# bower install --save sortablejs

• 在*vue文件中引入

import Sortable from 'sortablejs'

• 使用

<template>
	<!-- 注意这里的 row-key 需要设置，否则拖动排序可能显示不正常 -->
    <el-table :data="tableList" row-key="id">
        <el-table-column prop="..." label="..."></el-table-column>
        ...
    </el-table>
</template>

mounted() {
  // 初始化，因为是写死的数据所以在mounted中初始化，实际情况是在tableList赋值之后再初始化
  this.initSort()
},
methods: {
  initSort() {
    const el = document.querySelectorAll('.el-table__body-wrapper > table > tbody')[0]
    const sortable = new Sortable(el, {
      onEnd: evt => {
        const curRow = this.tableList.splice(evt.oldIndex, 1)[0]
        this.tableList.splice(evt.newIndex, 0, curRow)
        // this.updateSort() 更新数据库，将排序后的数据传给后端
      }
    })
  }
}

备注

// 配置项
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
  }
})

参考

http://www.sortablejs.com/options.html