拖放排序插件Sortable.js

Sortable.js是一个功能强大的JavaScript插件,支持触屏设备和大部分浏览器的拖放排序功能,适用于IE9以上。它允许用户在列表容器间拖拽排序,具有CSS动画支持和自定义选项。文章详细介绍了Sortable.js的创建方法、配置项及其各种事件监听器,如onStart、onEnd等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Sortable.js是一款轻量级的拖放排序列表的js插件(虽然体积小,但是功能很强大)
先附上插件下载地址:

1.官方GTIHUB:https://github.com/SortableJS/Sortable
特点

  1. 支持触屏设备和大部分浏览器(IE9以下的就不支持了,原因都懂得)
  2. 可以从一个列表容器中拖拽一个列表单元到其他容器或本列表容器中进行排序移动
  3. 表单元时有css动画
  4. 支持拖放操作和可选择的文本(这句我也没理解,大概意思就是对原生的拖放进行拓展了)
    例子
<ul id="items">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ul>

可以通过Sorable对象中的create方法创建

var el = document.getElementById('items');
var sortable = Sortable.create(el,{});

配置项:

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
    }
});
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值