Sortablejs

## 安装

```
npm install sortablejs --save
```

## 快速使用

首先在vue文件中定义一个需要排序的表格。

```
<el-table
    id="student"
    :data="Student"
    table-layout="fixed"
    row-key="ID"
  >
    <el-table-column prop="Name" label="Name"/>
 </el-table>
```

`Student`的数据如下。

```
this.Student = [
    {
        "ID": 1,
        "Name": Student1
    },
    {
        "ID": 2,
        "Name": Student2
    }
]
```

创建一个方法初始化`sortablejs`，由于element ui中，el-table的顺序实际上是根据`:data`中数据的顺序决定的，因此在完成排序后，还需要更新`:data`中的数据。

```
initSortable() {
  const studentTable = document.querySelector("#student tbody")
  this.sortable = new Sortable(studentTable, {
    disabled: !this.allowSort,
    animation: 100,
    onEnd: (evt) => {
      const newIndex = evt.newIndex
      const oldIndex = evt.oldIndex
      const movedItem = this.Student.splice(oldIndex, 1)[0]
      this.Student.splice(newIndex, 0, movedItem)
    }
  })
},
```

利用`disabled: !this.allowSort`属性来决定是否启用排序。

```
switchAllowSort(){
  this.sortable.option('disabled', !this.allowSort)
},
```

最后在页面加载完时调用`initSortable`初始化函数。

```
mounted() {
    this.initSortable()
}
```

## 完整配置

```
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) {},
	// 元素未被选中的时候（从选中到未选中）
	onUnchoose: function(/**Event*/evt) {},
	// 开始拖拽的时候
	onStart: function (/**Event*/evt) {
		evt.oldIndex;
	},
	// 结束拖拽
	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) {},
	// 列表内元素顺序更新的时候触发
	onUpdate: function (/**Event*/evt) {},
	// 列表的任何更改都会触发
	onSort: function (/**Event*/evt) {},
	// 元素从列表中移除进入另一个列表
	onRemove: function (/**Event*/evt) {},
	// 试图拖拽一个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
	}
});
```

Sortablejs

酷酷番茄