Sortable简单实用的HTML5拖放API插件 - 文章教程


发布于 2017-05-26 字数 18138 浏览 4203 评论 0

Sortable是一个原生的JavaScript拖放插件,它使用 HTML5 原生的拖放 API 来实现拖放,所以也不支持 IE9 以下浏览器,但是可以支持在触屏设备上使用,不依赖任何第三方插件。


  • 支持触摸设备和现代浏览器(包括IE9)
  • 可以从一个列表拖动到另一个列表或在同一列表中
  • 移动物品时的CSS动画
  • 支持拖动手柄和可选的文字(比voidberg的html5sortable)
  • 智能自动滚动
  • 内置使用原生HTML5拖放API
  • 支持任何CSS库,例如Bootstrap
  • 简单的API


<ul id="items">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
var el = document.getElementById('items');
var sortable = Sortable.create(el);

您可以使用任何元素的列表和它的元素,而不仅仅是 ul/li 列表。


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)
    preventOnFilter: true, // Call `event.preventDefault()` when triggered `filter`
    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:,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 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|'clone'|function — ability to move from the list. clone — copy the item, rather than move.
  • put: true|false|["foo", "bar"]|function — whether elements can be added from other lists, or an array of group names from which elements can be taken.
  • revertClone: boolean — revert cloned element to initial position after moving to a another list.


sort option

Sorting inside list.


delay option

Time in milliseconds to define when the sorting should start.


disabled options

Disables the sortable if set to true.


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.create(el, {
	handle: ".my-handle"
	<li><span class="my-handle">::</span> list item text one
	<li><span class="my-handle">::</span> list item text two
.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 =;

		if (, ".js-remove")) {  // Click on remove button
			item.parentNode.removeChild(item); // remove sortable item
		else if (, ".js-edit")) {  // Click on edit link
			// ...

ghostClass option

Class name for the drop placeholder (default sortable-ghost).


.ghost {
  opacity: 0.4;
Sortable.create(list, {
  ghostClass: "ghost"

chosenClass option

Class name for the chosen item (default sortable-chosen).


.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.


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.

scroll option

If set to true, the page (or sortable-area) scrolls when coming to an edge.


scrollFn option

Defines function that will be used for autoscrolling. el.scrollTop/el.scrollLeft is used by default. Useful when you have custom scrollbar with dedicated scroll function.

scrollSensitivity option

Defines how near the mouse must be to an edge to start scrolling.

scrollSpeed option

The speed at which the window should scroll once the mouse pointer gets within the scrollSensitivity distance.


  • 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

move event object

  • to:HTMLElement
  • from:HTMLElement
  • dragged:HTMLElement
  • draggedRect:TextRectangle
  • related:HTMLElement — element on which have guided
  • relatedRect:TextRectangle
option(name:String[, value:*]):*

Get or set the option.

closest(el:String[, selector: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.


Serializes the sortable’s item data-id‘s (dataIdAttr option) into an array of string.


Sorts the elements according to the array.

var order = sortable.toArray();
sortable.sort(order.reverse()); // apply

Save the current sorting (see store)


Removes the sortable functionality completely.


Saving and restoring of the sort.

	<li data-id="1">order</li>
	<li data-id="2">save</li>
	<li data-id="3">restore</li>
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(;
			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(, order.join('|'));



<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" target="_blank" class="external-link" href=""/>

<!-- Latest Sortable -->
<script src=""></script>

<!-- Simple List -->
<ul id="simpleList" class="list-group">
	<li class="list-group-item">This is <a target="_blank" class="external-link" href="">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>

    // Simple list
    Sortable.create(simpleList, { /* options */ });

Static methods & properties

Sortable.create(el:HTMLElement[, options:Object]):Sortable

Create new instance.

Link to the active instance.

  • 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


<!-- CDNJS :: Sortable ( -->
<script src="//"></script>

<!-- jsDelivr :: Sortable ( -->
<script src="//"></script>

<!-- jsDelivr :: Sortable :: Latest ( -->
<script src="//"></script>


如果你对这篇文章有疑问,欢迎到本站 社区 发帖提问或使用手Q扫描下方二维码加群参与讨论,获取更多帮助。



需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。





2583 文章
29 评论
84935 人气



文章 1 评论 0


文章 0 评论 0


文章 0 评论 0


文章 0 评论 0


文章 0 评论 0