![logo](https://image.upwqy.com/asset/images/logo.gif)
1、安装
1.1 使用npm
安装
npm install sortablejs --save
1.2 使用bwser
安装
bower install --save sortablejs
1.3 使用script引入
<script src="../../js/Sortable.min.js"></script>
2、实例
2.1 简单列表排序
new Sortable(example1, {
animation: 150,
ghostClass: 'blue-background-class'
});
2.2 禁用排序
new Sortable(example4Left, {
group: {
name: 'shared',
pull: 'clone',
put: false // 不允许拖拽进这个列表
},
animation: 150,
sort: false // 设为false,禁止sort
});
2.2 handle
可以设置指定元素进行拖拽排序
new Sortable(example5, {
handle: '.handle', // handle's class
animation: 150
});
2.3 针对element-ui
中的el-table
组件设置排序
2.3.1 页面部分
<el-table-column label="排序">
<template>
<span class="drag-sort" style="cursor: pointer;font-size: 18px;color: #222"> <i class="el-icon-rank" /></span>
</template>
</el-table-column>
2.3.2 js 部分
import { getCourseList } from '@/api/course'
import Sortable from 'sortablejs'
export default {
name: 'Course',
components: {
},
data() {
return {
tableData: [],
oldList: [],
newList: [],
listLoading: false,
total: 0,
listQuery: {}
}
},
created() {
this.getList()
},
methods: {
getList() {
this.listLoading = true
getCourseList(this.listQuery).then(res => {
this.tableData = res.data.data
this.total = res.data.total
this.listLoading = false
this.oldList = this.tableData.map(v => v.id)
this.newList = this.oldList.slice()
})
this.$nextTick(() => {
this.setSort()
})
},
setSort() {
const el = this.$refs.table.$el.querySelectorAll('.el-table__body-wrapper > table > tbody')[0]
Sortable.create(el, {
ghostClass: 'sortable-ghost', // Class name for the drop placeholder,
handle: '.drag-sort',
onEnd: evt => {
const targetRow = this.tableData.splice(evt.oldIndex, 1)[0]
this.tableData.splice(evt.newIndex, 0, targetRow)
const tempIndex = this.newList.splice(evt.oldIndex, 1)[0]
this.newList.splice(evt.newIndex, 0, tempIndex)
const data = {
new_ids: this.newList
}
console.log(data)
}
})
}
}
}
3、配置项
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
}
});
new Sortable(example5, {
handle: '.handle', // handle's class
animation: 150,
group: 'name'
})
new Sortable(example5, {
handle: '.handle', // handle's class
animation: 150,
group: {
name: 'shared',
pull: 'clone',
put: false // 不允许拖拽进这个列表
},
})
/**
*
* name:同string的方法,
* pull:pull用来定义从这个列表容器移动出去的设置,true/false/'clone'/function
* true:列表容器内的列表单元可以被移出;
* false:列表容器内的列表单元不可以被移出;
* 'clone':列表单元移出,移动的为该元素的副本;
* function:用来进行pull的函数判断,可以进行复杂逻辑,在函数中return false/true来判断是否移出;
* put:put用来定义往这个列表容器放置列表单元的的设置,true/false/['foo','bar']/function
* true:列表容器可以从其他列表容器内放入列表单元;
* false:与true相反;
* ['foo','bar']:这个可以是一个字符串或者是字符串的数组,代表的是group配置项里定义的name值;
* function:用来进行put的函数判断,可以进行复杂逻辑,在函数中return false/true来判断是否放入;
*/
事件
事件对象
事件对象在各个函数中略有不同,可通过输出对象查看对象的属性,下面简单列举几个:
方法