Sortable
Sortable is a JavaScript library for reorderable drag-and-drop lists.
Sortable是一个JavaScript库,用于可重新排序的拖放列表。
Demo: http://sortablejs.github.io/Sortable/
Features
Supports touch devices and modern browsers (including IE9)
Can drag from one list to another or within the same list
CSS animation when moving items
Supports drag handles and selectable text (better than voidberg's html5sortable)
Smart auto-scrolling
Advanced swap detection
Smooth animations
Multi-drag support
Support for CSS transforms
Built using native HTML5 drag and drop API
Supports
Supports any CSS library, e.g. Bootstrap
Simple API
Support for plugins
No jQuery required (but there is support)
Typescript definitions at
@types/sortablejs
[译]支持触摸设备和现代浏览器(包括IE9)
可以从一个列表拖动到另一个列表或在同一列表内
移动项目时的CSS动画
支持拖动手柄和_可选文本_(比voidberg的html5sortable更好)
智能自动滚动
高级交换检测
流畅的动画
支持CSS转换
使用原生HTML5拖放API构建
支持
支持任何CSS库,例如Bootstrap
简单的API
支持插件
不需要jQuery(但有支持)
typescript定义在
@types/sortablejs
上
Articles
- Dragging Multiple Items in Sortable (April 26, 2019)
- Swap Thresholds and Direction (December 2, 2018)
- Sortable v1.0 — New capabilities (December 22, 2014)
- Sorting with the help of HTML5 Drag'n'Drop API (December 23, 2013)
Getting Started
Install with NPM:
$ npm install sortablejs --save
Install with Bower:
$ bower install --save sortablejs
Import into your project:
// Default SortableJS
import Sortable from 'sortablejs';
// Core SortableJS (without default plugins)
import Sortable from 'sortablejs/modular/sortable.core.esm.js';
// Complete SortableJS (with all plugins)
import Sortable from 'sortablejs/modular/sortable.complete.esm.js';
Cherrypick plugins:
// Cherrypick extra plugins
import Sortable, { MultiDrag, Swap } from 'sortablejs';
Sortable.mount(new MultiDrag(), new Swap());
// Cherrypick default plugins
import Sortable, { AutoScroll } from 'sortablejs/modular/sortable.core.esm.js';
Sortable.mount(new AutoScroll());
Usage
<ul id="items">
<li>item 1</li>
<li>item 2</li>
<li>item 3</li>
</ul>
var el = document.getElementById('items');
var sortable = Sortable.create(el);
You can use any element for the list and its elements, not just ul
/li
. Here is an example with div
s.
[译]您可以对列表及其元素使用任何元素,而不仅仅是ul
/li
。 这是一个使用div的示例。
Options
var sortable = new Sortable(el, {
group: "name", // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }
sort: true, // sorting inside list
delay: 0, // time in milliseconds to define when the sorting should start
delayOnTouchOnly: false, // only delay if user is using touch
touchStartThreshold: 0, // px, how many pixels the point should move before cancelling a delayed drag event
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
easing: "cubic-bezier(1, 0, 0, 1)", // Easing for animation. Defaults to null. See https://easings.net/ for examples.
handle: ".my-handle", // Drag handle selector within list items
filter: ".ignore-elements", // Selectors that do not lead to dragging (String or Function)
preventOnFilter: true, // Call `event.preventDefault()` when triggered `filter`
draggable: ".item", // Specifies which items inside the element should be draggable
dataIdAttr: 'data-id',
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
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', // Direction of Sortable (will be detected automatically if not given)
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.
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
},
// Element is chosen
onChoose: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// Element is unchosen
onUnchoose: function(/**Event*/evt) {
// same properties as onEnd
},
// Element dragging started
onStart: function (/**Event*/evt) {
evt.oldIndex; // element index within parent
},
// Element dragging ended
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.oldDraggableIndex; // element's old index within old parent, only counting draggable elements
evt.newDraggableIndex; // element's new index within new parent, only counting draggable elements
evt.clone // the clone element
evt.pullMode; // when item is in another sortable: `"clone"` if cloning, `true` if moving
},
// Element is dropped into the list from another list
onAdd: function (/**Event*/evt) {
// same properties as onEnd
},
// Changed sorting within list
onUpdate: function (/**Event*/evt) {
// same properties as onEnd
},
// Called by any change to the list (add / update / remove)
onSort: function (/**Event*/evt) {
// same properties as onEnd
},
// Element is removed from the list into another list
onRemove: function (/**Event*/evt) {
// same properties as onEnd
},
// 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: 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
},
// Called when creating a clone of element
onClone: function (/**Event*/evt) {
var origEl = evt.item;
var cloneEl = evt.clone;
},
// Called when dragging element changes position
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
}
});
group
option
To drag elements from one list into another, both lists must have the same group
value. You can also define whether lists can give away, give and keep a copy (clone
), and receive elements.
- name:
String
— group name - pull:
true|false|["foo", "bar"]|'clone'|function
— ability to move from the list.clone
— copy the item, rather than move. Or an array of group names which the elements may be put in. Defaults totrue
. - put:
true|false|["baz", "qux"]|function
— whether elements can be added from other lists, or an array of group names from which elements can be added. - revertClone:
boolean
— revert cloned element to initial position after moving to a another list.
[译]要将元素从一个列表拖到另一个列表中,两个列表必须具有相同的group
值。 您还可以定义列表是否可以放弃,给予和保留副本(clone
)以及接收元素。
- name:
String
—组名 - pull:
true|false|["foo", "bar"]|'clone'|function
-从列表中移出的能力。clone
—复制项目,而不是移动。 或元素可以放入的一组组名。默认为true
。 - put:
true|false|["baz", "qux"]|function
—是否可以从其他列表中添加元素,或者可以从中添加元素的组名数组。 - revertClone:
boolean
—将克隆的元素移动到另一个列表后将其还原到初始位置。
Demo:
- https://jsbin.com/hijetos/edit?js,output
- https://jsbin.com/nacoyah/edit?js,output — use of complex logic in the
pull
andput
- https://jsbin.com/bifuyab/edit?js,output — use
revertClone: true
sort
option
Allow sorting inside list.
[译]允许在列表内排序。
Demo: https://jsbin.com/jayedig/edit?js,output
delay
option
Time in milliseconds to define when the sorting should start. Unfortunately, due to browser restrictions, delaying is not possible on IE or Edge with native drag & drop.
[译]定义排序开始时间的时间(以毫秒为单位)。 不幸的是,由于浏览器的限制,无法通过本地拖放在IE或Edge上进行延迟。
Demo: https://jsbin.com/zosiwah/edit?js,output
delayOnTouchOnly
option
Whether or not the delay should be applied only if the user is using touch (eg. on a mobile device). No delay will be applied in any other case. Defaults to false
.
[译]是否仅在用户使用触摸(例如在移动设备上)时才应应用延迟。 在任何其他情况下,都不会延迟。 默认为false
。
swapThreshold
option
Percentage of the target that the swap zone will take up, as a float between 0
and 1
.
[译]交换区域将占用的目标百分比,介于0
和1
之间。
Demo: http://sortablejs.github.io/Sortable#thresholds
invertSwap
option
Set to true
to set the swap zone to the sides of the target, for the effect of sorting "in between" items.
[译]设置为true
可以将交换区域设置在目标的侧面,以实现在项目之间“in between”的效果。
Demo: http://sortablejs.github.io/Sortable#thresholds
invertedSwapThreshold
option
Percentage of the target that the inverted swap zone will take up, as a float between 0
and 1
. If not given, will default to swapThreshold
.
[译]反向交换区域将占据的目标百分比,介于0
和1
之间的浮点数。如果未指定,则默认为swapThreshold
。
direction
option
Direction that the Sortable should sort in. Can be set to 'vertical'
, 'horizontal'
, or a function, which will be called whenever a target is dragged over. Must return 'vertical'
or 'horizontal'
.
[译]Sortable应该排序的方向。可以设置为'vertical'
,'horizontal'
或函数,只要将目标拖到上方,就会调用该函数。 必须返回'vertical'
或'horizontal'
。
Example of direction detection for vertical list that includes full column and half column elements:
[译]垂直列表的方向检测示例,其中包括整列和半列元素:
Sortable.create(el, {
direction: function(evt, target, dragEl) {
if (target !== null && target.className.includes('half-column') && dragEl.className.includes('half-column')) {
return 'horizontal';
}
return 'vertical';
}
});
touchStartThreshold
option
This option is similar to fallbackTolerance
option.
When the delay
option is set, some phones with very sensitive touch displays like the Samsung Galaxy S8 will fire unwanted touchmove events even when your finger is not moving, resulting in the sort not triggering.
This option sets the minimum pointer movement that must occur before the delayed sorting is cancelled.
Values between 3 to 5 are good.
[译]此选项类似于fallbackTolerance
选项。
设置delay
选项后,即使手指不动,某些具有非常敏感的触摸显示屏的手机(如三星Galaxy S8)也会触发不需要的触摸移动事件,从而导致排序不会触发。
此选项设置取消延迟排序之前必须发生的最小指针移动。
3到5之间的值是好的。
disabled
options
Disables the sortable if set to true
.
[译]如果设置为true
,则禁用sortable。
Demo: https://jsbin.com/sewokud/edit?js,output
var sortable = Sortable.create(list);
document.getElementById("switcher").onclick = function () {
var state = sortable.option("disabled"); // get
sortable.option("disabled", !state); // set
};
handle
option
To make list items draggable, Sortable disables text selection by the user. That's not always desirable. To allow text selection, define a drag handler, which is an area of every list element that allows it to be dragged around.
[译]为了使列表项可拖动,Sortable可禁用用户的文本选择。 这并不总是可取的。 要允许选择文本,需要定义一个拖动handler,该handler是每个列表元素都可以在其中拖动的区域。
Demo: https://jsbin.com/numakuh/edit?html,js,output
Sortable.create(el, {
handle: ".my-handle"
});
<ul>
<li><span class="my-handle">::</span> list item text one
</li><li><span class="my-handle">::</span> list item text two
</li></ul>
.my-handle {
cursor: move;
cursor: -webkit-grabbing;
}
filter
option
Sortable.create(list, {
filter: ".js-remove, .js-edit",
onFilter: function (evt) {
var item = evt.item,
ctrl = evt.target;
if (Sortable.utils.is(ctrl, ".js-remove")) { // Click on remove button
item.parentNode.removeChild(item); // remove sortable item
}
else if (Sortable.utils.is(ctrl, ".js-edit")) { // Click on edit link
// ...
}
}
})
ghostClass
option
Class name for the drop placeholder (default sortable-ghost
).
[译]放置占位符的类名称(默认为sortable-ghost
)。
Demo: https://jsbin.com/henuyiw/edit?css,js,output
.ghost {
opacity: 0.4;
}
Sortable.create(list, {
ghostClass: "ghost"
});
chosenClass
option
Class name for the chosen item (default sortable-chosen
).
[译]所选项目的类名称(默认为sortable-chosen
)。
Demo: https://jsbin.com/hoqufox/edit?css,js,output
.chosen {
color: #fff;
background-color: #c00;
}
Sortable.create(list, {
delay: 500,
chosenClass: "chosen"
});
forceFallback
option
If set to true
, the Fallback for non HTML5 Browser will be used, even if we are using an HTML5 Browser. This gives us the possibility to test the behaviour for older Browsers even in newer Browser, or make the Drag 'n Drop feel more consistent between Desktop , Mobile and old Browsers.
On top of that, the Fallback always generates a copy of that DOM Element and appends the class fallbackClass
defined in the options. This behaviour controls the look of this 'dragged' Element.
[译]如果设置为true
,则即使我们使用的是HTML5浏览器,也将使用非HTML5浏览器的Fallback。 这使我们能够测试旧版浏览器的行为,甚至是在新版浏览器中,也可以使桌面浏览器,移动版浏览器和旧版浏览器之间的拖放感觉更加一致。
最重要的是,Fallback始终会生成该DOM元素的副本,并附加在选项中定义的fallbackClass
类。 此行为控制此“拖动”元素的外观。
Demo: https://jsbin.com/sibiput/edit?html,css,js,output
fallbackTolerance
option
Emulates the native drag threshold. Specify in pixels how far the mouse should move before it's considered as a drag. Useful if the items are also clickable like in a list of links.
When the user clicks inside a sortable element, it's not uncommon for your hand to move a little between the time you press and the time you release. Dragging only starts if you move the pointer past a certain tolerance, so that you don't accidentally start dragging every time you click.
3 to 5 are probably good values.
[译]模拟本地拖动阈值。 指定以像素为单位的鼠标在被视为拖动之前应移动的距离。 如果项目也可以单击,例如在链接列表中,则很有用。
当用户在可排序元素内单击时,在按下和松开之间,您的手通常会略微移动。 仅当您将指针移过一定的公差时才开始拖动,这样您就不会在每次单击时意外开始拖动。
3到5可能是不错的值。
dragoverBubble
option
If set to true
, the dragover event will bubble to parent sortables. Works on both fallback and native dragover event. By default, it is false, but Sortable will only stop bubbling the event once the element has been inserted into a parent Sortable, or can be inserted into a parent Sortable, but isn't at that specific time (due to animation, etc).
Since 1.8.0, you will probably want to leave this option as false. Before 1.8.0, it may need to be true
for nested sortables to work.
[译]如果设置为true
,则拖动事件将冒泡到父可排序对象。 适用于fallback和本机拖动事件。 默认情况下,它为false,但是Sortable仅在将元素插入到父Sortable中或_可以_插入到父Sortable中后才停止冒泡事件,但不在特定时间(由于动画等) 。
从1.8.0开始,您可能希望将此选项保留为false。 在1.8.0之前,嵌套可排序项可能必须为true
才能工作。
removeCloneOnHide
option
If set to false
, the clone is hidden by having it's CSS display
property set to none
. By default, this option is true
, meaning Sortable will remove the cloned element from the DOM when it is supposed to be hidden.
[译]如果设置为false
,则通过将其CSSdisplay
属性设置为none
来隐藏克隆。 默认情况下,此选项为true
,这意味着Sortable在应隐藏的情况下将从DOM中删除克隆的元素。
emptyInsertThreshold
option
The distance (in pixels) the mouse must be from an empty sortable while dragging for the drag element to be inserted into that sortable. Defaults to 5
. Set to 0
to disable this feature.
[译]拖动时鼠标必须与一个空的可排序对象之间的距离(以像素为单位),以便将拖动元素插入到该可排序对象中。 默认值为5
。设置为0
以禁用此功能。
Demo: https://jsbin.com/becavoj/edit?js,output
Event object (demo)
- to:
HTMLElement
— list, in which moved element - from:
HTMLElement
— previous list - item:
HTMLElement
— dragged element - clone:
HTMLElement
- oldIndex:
Number|undefined
— old index within parent - newIndex:
Number|undefined
— new index within parent - oldDraggableIndex:
Number|undefined
— old index within parent, only counting draggable elements - newDraggableIndex:
Number|undefined
— new index within parent, only counting draggable elements - pullMode:
String|Boolean|undefined
— Pull mode if dragging into another sortable ("clone"
,true
, orfalse
), otherwise undefined
[译]
- to:
HTMLElement
—列表,其中已移动元素 - from:
HTMLElement
—上一个列表 - item:
HTMLElement
—拖动的元素 - clone:
HTMLElement
- oldIndex:
Number|undefined
—父级中的旧索引 - newIndex:
Number|undefined
—父级中的新索引 - oldDraggableIndex:
Number|undefined
—父级中的旧索引,仅计算可拖动元素 - newDraggableIndex:
Number|undefined
—父级中的新索引,仅计算可拖动元素 - pullMode:
String|Boolean|undefined
—如果拖动到另一个可排序("clone"
,true
, 或false
)中,则为拉模式,否则为undefined
move
event object
- to:
HTMLElement
- from:
HTMLElement
- dragged:
HTMLElement
- draggedRect:
DOMRect
- related:
HTMLElement
— element on which have guided - relatedRect:
DOMRect
- willInsertAfter:
Boolean
—true
if will element be inserted after target (orfalse
if before)
Method
option(name:String
[, value:*
]):*
Get or set the option.
closest(el:HTMLElement
[, selector:String
]):HTMLElement|null
For each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree.
[译]对于集合中的每个元素,通过测试元素本身并在DOM树中遍历其祖先,获得与选择器匹配的第一个元素。
toArray():String[]
Serializes the sortable's item data-id
's (dataIdAttr
option) into an array of string.
[译]将可排序项的项目data-id
(dataIdAttr
option)序列化为字符串数组。
sort(order:String[]
)
Sorts the elements according to the array.
var order = sortable.toArray();
sortable.sort(order.reverse()); // apply
save()
Save the current sorting (see store)
destroy()
Removes the sortable functionality completely.
Store
Saving and restoring of the sort.
<ul>
<li data-id="1">order</li>
<li data-id="2">save</li>
<li data-id="3">restore</li>
</ul>
Sortable.create(el, {
group: "localStorage-example",
store: {
/**
* Get the order of elements. Called once during initialization.
* @param {Sortable} sortable
* @returns {Array}
*/
get: function (sortable) {
var order = localStorage.getItem(sortable.options.group.name);
return order ? order.split('|') : [];
},
/**
* Save the order of elements. Called onEnd (when the item is dropped).
* @param {Sortable} sortable
*/
set: function (sortable) {
var order = sortable.toArray();
localStorage.setItem(sortable.options.group.name, order.join('|'));
}
}
})
Bootstrap
Demo: https://jsbin.com/visimub/edit?html,js,output
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
<!-- Latest Sortable -->
<script src="http://SortableJS.github.io/Sortable/Sortable.js"></script>
<!-- Simple List -->
<ul id="simpleList" class="list-group">
<li class="list-group-item">This is <a href="http://SortableJS.github.io/Sortable/">Sortable</a></li>
<li class="list-group-item">It works with Bootstrap...</li>
<li class="list-group-item">...out of the box.</li>
<li class="list-group-item">It has support for touch devices.</li>
<li class="list-group-item">Just drag some elements around.</li>
</ul>
<script>
// Simple list
Sortable.create(simpleList, { /* options */ });
</script>
Static methods & properties
Sortable.create(el:HTMLElement
[, options:Object
]):Sortable
Create new instance.
Sortable.active:Sortable
The active Sortable instance.
Sortable.dragged:HTMLElement
The element being dragged.
Sortable.ghost:HTMLElement
The ghost element.
Sortable.clone:HTMLElement
The clone element.
Sortable.get(element:HTMLElement
):Sortable
Get the Sortable instance on an element.
Sortable.mount(plugin:...SortablePlugin|SortablePlugin[]
)
Mounts a plugin to Sortable.
Sortable.utils
- on(el
:HTMLElement
, event:String
, fn:Function
) — attach an event handler function - off(el
:HTMLElement
, event:String
, fn:Function
) — remove an event handler - css(el
:HTMLElement
):Object
— get the values of all the CSS properties - css(el
:HTMLElement
, prop:String
):Mixed
— get the value of style properties - css(el
:HTMLElement
, prop:String
, value:String
) — set one CSS properties - css(el
:HTMLElement
, props:Object
) — set more CSS properties - find(ctx
:HTMLElement
, tagName:String
[, iterator:Function
]):Array
— get elements by tag name - bind(ctx
:Mixed
, fn:Function
):Function
— Takes a function and returns a new one that will always have a particular context - is(el
:HTMLElement
, selector:String
):Boolean
— check the current matched set of elements against a selector - closest(el
:HTMLElement
, selector:String
[, ctx:HTMLElement
]):HTMLElement|Null
— for each element in the set, get the first element that matches the selector by testing the element itself and traversing up through its ancestors in the DOM tree - clone(el
:HTMLElement
):HTMLElement
— create a deep copy of the set of matched elements - toggleClass(el
:HTMLElement
, name:String
, state:Boolean
) — add or remove one classes from each element - detectDirection(el
:HTMLElement
):String
— automatically detect the direction of the element as either'vertical'
or'horizontal'
Plugins
Extra Plugins (included in complete versions)
Default Plugins (included in default versions)
CDN
<!-- jsDelivr :: Sortable :: Latest (https://www.jsdelivr.com/package/npm/sortablejs) -->
<script src="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>
Contributing (Issue/PR)
Please, read this.
Contributors
Code Contributors
This project exists thanks to all the people who contribute. [Contribute].
Financial Contributors
Become a financial contributor and help us sustain our community. [Contribute]
Individuals
Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]
MIT LICENSE
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.