拖放排序插件Sortable.js兼容好及功能全个人觉得比dragula.js好的多
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
拖放排序插件Sortable.js兼容好及功能全个⼈觉得⽐dragula.js
好的多
经测试,Sortable.js 兼容好和使⽤⽅便都是⽐较不错的,特别⼿机端使⽤很棒
介绍
Sortable.js是⼀款轻量级的拖放排序列表的js插件(虽然体积⼩,但是功能很强⼤)
下载地址:
官⽅DEMO:
特点
⽀持触屏设备和⼤部分浏览器(IE9以下的就不⽀持了,原因都懂得)
可以从⼀个列表容器中拖拽⼀个列表单元到其他容器或本列表容器中进⾏排序
移动列表单元时有css动画
⽀持拖放操作和可选择的⽂本(这句我也没理解,⼤概意思就是对原⽣的拖放进⾏拓展了)
⾮常友善的滚动效果
基于原⽣HTML5中的拖放API
⽀持多种框架(angular、vue、react等)
⽀持所有的css框架,像Bootstrap
简单的API,⽅便使⽤
CDN
不依赖jQuery
VUE框架中使⽤,见这⾥:
使⽤举例
<script src="../js/sortable.min.js?v=0.0"></script>
var el = document.getElementById('items');
new Sortable(el);
//常⽤
new Sortable(el, {
handle: ".my-handle", // 拖拽区域,默认为 items 的⼦元素
onStart: function (/**Event*/evt) { // 拖拽开始
var itemEl = evt.item;// 当前拖拽的html元素
},
onEnd: function (/**Event*/evt) { // 拖拽结束
var itemEl = evt.item;
}
});
如是2组之间拖放:
new Sortable(document.getElementById('C_fieldSet_01'), {
group: ".C_move",
handle: ".C_move"
});
new Sortable(document.getElementById('C_fieldSet_02'), {
group: ".C_move",
handle: ".C_move"
});
配置项
var sortable = new Sortable(el, {
group: "name", // or { name: "...", pull: [true, false, clone], put: [true, false, array] }
sort: true, // sorting inside list
delay: 0, // time in milliseconds to define when the sorting should start
disabled: false, // Disables the sortable if set to true.
store: null, // @see Store
animation: 150, // ms, animation speed moving items when sorting, `0` — without animation
handle: ".my-handle", // Drag handle selector within list items
filter: ".ignore-elements", // Selectors that do not lead to dragging (String or Function)
draggable: ".item", // Specifies which items inside the element should be draggable
ghostClass: "sortable-ghost", // Class name for the drop placeholder
chosenClass: "sortable-chosen", // Class name for the chosen item
dragClass: "sortable-drag", // Class name for the dragging item
dataIdAttr: 'data-id',
forceFallback: false, // ignore the HTML5 DnD behaviour and force the fallback to kick in
fallbackClass: "sortable-fallback", // Class name for the cloned DOM Element when using forceFallback
fallbackOnBody: false, // Appends the cloned DOM Element into the Document's 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) { ... }, // 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
setData: function (/** DataTransfer */dataTransfer, /** HTMLElement*/dragEl) {
dataTransfer.setData('Text', dragEl.textContent); // `dataTransfer` object of HTML5 DragEvent
},
// Element is chosen
onChoose: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// Element dragging started
onStart: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// Element dragging ended
onEnd: function (/**Event*/evt) {
evt.oldIndex; // element's old index within parent
evt.newIndex; // element's new index within parent
},
// Element is dropped into the list from another list
onAdd: function (/**Event*/evt) {
var itemEl = evt.item; // dragged HTMLElement
evt.from; // previous list
// + indexes from onEnd
},
// Changed sorting within list
onUpdate: function (/**Event*/evt) {
var itemEl = evt.item; // dragged HTMLElement
// + indexes from onEnd
},
// Called by any change to the list (add / update / remove)
onSort: function (/**Event*/evt) {
// same properties as onUpdate
},
// Element is removed from the list into another list
onRemove: function (/**Event*/evt) {
// same properties as onUpdate
},
// Attempt to drag a filtered element
onFilter: function (/**Event*/evt) {
var itemEl = evt.item; // HTMLElement receiving the `mousedown|tapstart` event.
},
// Event when you move an item in the list or between lists
onMove: function (/**Event*/evt, /**Event*/originalEvent) {
// Example: /tuyafe/1/edit?js,output
evt.dragged; // dragged HTMLElement
evt.draggedRect; // TextRectangle {left, top, right и bottom}
evt.related; // HTMLElement on which have guided
evt.relatedRect; // TextRectangle
originalEvent.clientY; // mouse position
// return false; — for cancel
},
// Called when creating a clone of element
onClone: function (/**Event*/evt) {
var origEl = evt.item;
var cloneEl = evt.clone;
}
});
属性
group:string or array
sort:boolean 定义是否列表单元是否可以在列表容器内进⾏拖拽排序;
delay:number 定义⿏标选中列表单元可以开始拖动的延迟时间;
disabled:boolean 定义是否此sortable对象是否可⽤,为true时sortable对象不能拖放排序等功能,为false时为可以进⾏排序,相当于⼀个开关;
animation:number 单位:ms,定义排序动画的时间;
handle:selector 格式为简单css选择器的字符串,使列表单元中符合选择器的元素成为拖动的⼿柄,只有按住拖动⼿柄才能使列表单元进⾏拖动;
filter:selector 格式为简单css选择器的字符串,定义哪些列表单元不能进⾏拖放,可设置为多个选择器,中间⽤“,”分隔;
draggable:selector 格式为简单css选择器的字符串,定义哪些列表单元可以进⾏拖放
ghostClass:selector 格式为简单css选择器的字符串,当拖动列表单元时会⽣成⼀个副本作为影⼦单元来模拟被拖动单元排序的情况,此配置项就是来给这个影⼦单元添加⼀个class,我们可以通过这种⽅式来给影⼦元素进⾏编辑样式;
chosenClass:selector 格式为简单css选择器的字符串,当选中列表单元时会给该单元增加⼀个class;
forceFallback:boolean 如果设置为true时,将不使⽤原⽣的html5的拖放,可以修改⼀些拖放中元素的样式等;
fallbackClass:string 当forceFallback设置为true时,拖放过程中⿏标附着单元的样式;
scroll:boolean 默认为true,当排序的容器是个可滚动的区域,拖放可以引起区域滚动
事件:
onChoose:function 列表单元被选中的回调函数
onStart:function 列表单元拖动开始的回调函数
onEnd:function 列表单元拖放结束后的回调函数
onAdd:function 列表单元添加到本列表容器的回调函数
onUpdate:function 列表单元在列表容器中的排序发⽣变化后的回调函数
onRemove:function 列表元素移到另⼀个列表容器的回调函数
onFilter:function 试图选中⼀个被filter过滤的列表单元的回调函数
onMove:function 当移动列表单元在⼀个列表容器中或者多个列表容器中的回调函数
onClone:function 当创建⼀个列表单元副本的时候的回调函数
事件对象:
事件对象在各个函数中略有不同,可通过输出对象查看对象的属性,下⾯简单列举⼏个:
to:HTMLElement--移动到列表容器
from:HTMLElement--来源的列表容器
item:HTMLElement--被移动的列表单元
clone:HTMLElement--副本的列表单元
oldIndex:number/undefined--在列表容器中的原序号
newIndex:number/undefined--在列表容器中的新序号
⽅法
option(name[,value])
获得或者设置项参数,使⽤⽅法类似于jQuery⽤法,没有第⼆个参数为获得option中第⼀个参数所对应的值,有第⼆个参数时,将重新赋给第⼀个参数所对应的值;
closest
没理解
toArray()
序列化可排序的列表单元的data-id(可通过配置项中dataIdAttr修改)放⼊⼀个数组,并返回这个数组中
sort()
通过⾃定义列表单元的data-id的数组对列表单元进⾏排序
save()
destroy()
收集来源:
(介绍的⽐较全⾯)
.。