A minimalist JavaScript library for reorderable drag-and-drop lists on mode...


Sortable   Financial Contributors on Open Collective CircleCI DeepScan grade undefined npm

Sortable is a JavaScript library for reorderable drag-and-drop lists.




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 any CSS library, e.g. Bootstrap
Simple API
Support for plugins
No jQuery required (but there is support)
Typescript definitions at @types/sortablejs


Swap Thresholds and Direction (December 2, 2018)

Getting Started

Install with NPM:
  1. ``` sh
  2. $ npm install sortablejs --save
  3. ```

Install with Bower:
  1. ``` sh
  2. $ bower install --save sortablejs
  3. ```

Import into your project:
  1. ``` js
  2. // Default SortableJS
  3. import Sortable from 'sortablejs';

  4. // Core SortableJS (without default plugins)
  5. import Sortable from 'sortablejs/modular/sortable.core.esm.js';

  6. // Complete SortableJS (with all plugins)
  7. import Sortable from 'sortablejs/modular/sortable.complete.esm.js';
  8. ```

Cherrypick plugins:
  1. ``` js
  2. // Cherrypick extra plugins
  3. import Sortable, { MultiDrag, Swap } from 'sortablejs';

  4. Sortable.mount(new MultiDrag(), new Swap());

  5. // Cherrypick default plugins
  6. import Sortable, { AutoScroll } from 'sortablejs/modular/sortable.core.esm.js';

  7. Sortable.mount(new AutoScroll());
  8. ```


  1. ``` html
  2. <ul id="items">
  3. <li>item 1</li>
  4. <li>item 2</li>
  5. <li>item 3</li>
  6. </ul>
  7. ```

  1. ``` js
  2. var el = document.getElementById('items');
  3. var sortable = Sortable.create(el);
  4. ```

You can use any element for the list and its elements, not just ul/li. Here is an [example with divs](,js,output).


  1. ``` js
  2. var sortable = new Sortable(el, {
  3. group: "name",  // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }
  4. sort: true,  // sorting inside list
  5. delay: 0, // time in milliseconds to define when the sorting should start
  6. delayOnTouchOnly: false, // only delay if user is using touch
  7. touchStartThreshold: 0, // px, how many pixels the point should move before cancelling a delayed drag event
  8. disabled: false, // Disables the sortable if set to true.
  9. store: null,  // @see Store
  10. animation: 150,  // ms, animation speed moving items when sorting, `0` — without animation
  11. easing: "cubic-bezier(1, 0, 0, 1)", // Easing for animation. Defaults to null. See for examples.
  12. handle: ".my-handle",  // Drag handle selector within list items
  13. filter: ".ignore-elements",  // Selectors that do not lead to dragging (String or Function)
  14. preventOnFilter: true, // Call `event.preventDefault()` when triggered `filter`
  15. draggable: ".item",  // Specifies which items inside the element should be draggable

  16. dataIdAttr: 'data-id', // HTML attribute that is used by the `toArray()` method

  17. ghostClass: "sortable-ghost",  // Class name for the drop placeholder
  18. chosenClass: "sortable-chosen",  // Class name for the chosen item
  19. dragClass: "sortable-drag",  // Class name for the dragging item

  20. swapThreshold: 1, // Threshold of the swap zone
  21. invertSwap: false, // Will always use inverted swap zone if set to true
  22. invertedSwapThreshold: 1, // Threshold of the inverted swap zone (will be set to swapThreshold value by default)
  23. direction: 'horizontal', // Direction of Sortable (will be detected automatically if not given)

  24. forceFallback: false,  // ignore the HTML5 DnD behaviour and force the fallback to kick in

  25. fallbackClass: "sortable-fallback",  // Class name for the cloned DOM Element when using forceFallback
  26. fallbackOnBody: false,  // Appends the cloned DOM Element into the Document's Body
  27. fallbackTolerance: 0, // Specify in pixels how far the mouse should move before it's considered as a drag.

  28. dragoverBubble: false,
  29. removeCloneOnHide: true, // Remove the clone element when it is not showing, rather than just hiding it
  30. emptyInsertThreshold: 5, // px, distance mouse must be from empty sortable to insert drag element into it

  31. setData: function (/** DataTransfer */dataTransfer, /** HTMLElement*/dragEl) {
  32.   dataTransfer.setData('Text', dragEl.textContent); // `dataTransfer` object of HTML5 DragEvent
  33. },

  34. // Element is chosen
  35. onChoose: function (/**Event*/evt) {
  36.   evt.oldIndex;  // element index within parent
  37. },

  38. // Element is unchosen
  39. onUnchoose: function(/**Event*/evt) {
  40.   // same properties as onEnd
  41. },

  42. // Element dragging started
  43. onStart: function (/**Event*/evt) {
  44.   evt.oldIndex;  // element index within parent
  45. },

  46. // Element dragging ended
  47. onEnd: function (/**Event*/evt) {
  48.   var itemEl = evt.item;  // dragged HTMLElement
  49.;    // target list
  50.   evt.from;  // previous list
  51.   evt.oldIndex;  // element's old index within old parent
  52.   evt.newIndex;  // element's new index within new parent
  53.   evt.oldDraggableIndex; // element's old index within old parent, only counting draggable elements
  54.   evt.newDraggableIndex; // element's new index within new parent, only counting draggable elements
  55.   evt.clone // the clone element
  56.   evt.pullMode;  // when item is in another sortable: `"clone"` if cloning, `true` if moving
  57. },

  58. // Element is dropped into the list from another list
  59. onAdd: function (/**Event*/evt) {
  60.   // same properties as onEnd
  61. },

  62. // Changed sorting within list
  63. onUpdate: function (/**Event*/evt) {
  64.   // same properties as onEnd
  65. },

  66. // Called by any change to the list (add / update / remove)
  67. onSort: function (/**Event*/evt) {
  68.   // same properties as onEnd
  69. },

  70. // Element is removed from the list into another list
  71. onRemove: function (/**Event*/evt) {
  72.   // same properties as onEnd
  73. },

  74. // Attempt to drag a filtered element
  75. onFilter: function (/**Event*/evt) {
  76.   var itemEl = evt.item;  // HTMLElement receiving the `mousedown|tapstart` event.
  77. },

  78. // Event when you move an item in the list or between lists
  79. onMove: function (/**Event*/evt, /**Event*/originalEvent) {
  80.   // Example:,output
  81.   evt.dragged; // dragged HTMLElement
  82.   evt.draggedRect; // DOMRect {left, top, right, bottom}
  83.   evt.related; // HTMLElement on which have guided
  84.   evt.relatedRect; // DOMRect
  85.   evt.willInsertAfter; // Boolean that is true if Sortable will insert drag element after target by default
  86.   originalEvent.clientY; // mouse position
  87.   // return false; — for cancel
  88.   // return -1; — insert before target
  89.   // return 1; — insert after target
  90.   // return true; — keep default insertion point based on the direction
  91.   // return void; — keep default insertion point based on the direction
  92. },

  93. // Called when creating a clone of element
  94. onClone: function (/**Event*/evt) {
  95.   var origEl = evt.item;
  96.   var cloneEl = evt.clone;
  97. },

  98. // Called when dragging element changes position
  99. onChange: function(/**Event*/evt) {
  100.   evt.newIndex // most likely why this event is used is to get the dragging element's current index
  101.   // same properties as onEnd
  102. }
  103. });
  104. ```

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

-,output — use of complex logic in the pull and put
-,output — use revertClone: true

sort option

Allow sorting inside list.


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.


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.

swapThreshold option

Percentage of the target that the swap zone will take up, as a float between 0 and 1.


invertSwap option

Set to true to set the swap zone to the sides of the target, for the effect of sorting "in between" items.


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.

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

Example of direction detection for vertical list that includes full column and half column elements:

  1. ``` js
  2. Sortable.create(el, {
  3. direction: function(evt, target, dragEl) {
  4.   if (target !== null && target.className.includes('half-column') && dragEl.className.includes('half-column')) {
  5.    return 'horizontal';
  6.   }
  7.   return 'vertical';
  8. }
  9. });
  10. ```

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.

disabled options

Disables the sortable if set to true.


  1. ``` js
  2. var sortable = Sortable.create(list);

  3. document.getElementById("switcher").onclick = function () {
  4. var state = sortable.option("disabled"); // get

  5. sortable.option("disabled", !state); // set
  6. };
  7. ```

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.


  1. ``` js
  2. Sortable.create(el, {
  3. handle: ".my-handle"
  4. });
  5. ```

  1. ``` html
  2. <ul>
  3. <li><span class="my-handle">::</span> list item text one
  4. <li><span class="my-handle">::</span> list item text two
  5. </ul>
  6. ```

  1. ```css
  2. .my-handle {
  3. cursor: move;
  4. cursor: -webkit-grabbing;
  5. }
  6. ```

filter option

  1. ``` js
  2. Sortable.create(list, {
  3. filter: ".js-remove, .js-edit",
  4. onFilter: function (evt) {
  5.   var item = evt.item,
  6.    ctrl =;

  7.   if (, ".js-remove")) {  // Click on remove button
  8.    item.parentNode.removeChild(item); // remove sortable item
  9.   }
  10.   else if (, ".js-edit")) {  // Click on edit link
  11.    // ...
  12.   }
  13. }
  14. })
  15. ```

ghostClass option

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


  1. ```css
  2. .ghost {
  3.   opacity: 0.4;
  4. }
  5. ```

  1. ``` js
  2. Sortable.create(list, {
  3.   ghostClass: "ghost"
  4. });
  5. ```

chosenClass option

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


  1. ```css
  2. .chosen {
  3.   color: #fff;
  4.   background-color: #c00;
  5. }
  6. ```

  1. ``` js
  2. Sortable.create(list, {
  3.   delay: 500,
  4.   chosenClass: "chosen"
  5. });
  6. ```

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.

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.

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.

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.


An alternative to this option would be to set a padding on your list when it is empty.

For example:
  1. ```css
  2. ul:
  3.   padding-bottom: 20px;
  4. }
  5. ```

Warning: For :empty to work, it must have no node inside (even text one).


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, or false), otherwise undefined

move event object

- to:HTMLElement
- from:HTMLElement
- dragged:HTMLElement
- draggedRect:DOMRect
- related:HTMLElement — element on which have guided
- relatedRect:DOMRect
- willInsertAfter:Booleantrue if will element be inserted after target (or false if before)


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.

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

sort(order:String[], useAnimation:Boolean)
Sorts the elements according to the array.

  1. ``` js
  2. var order = sortable.toArray();
  3. sortable.sort(order.reverse(), true); // apply
  4. ```

Save the current sorting (see store)

Removes the sortable functionality completely.


Saving and restoring of the sort.

  1. ``` html
  2. <ul>
  3. <li data-id="1">order</li>
  4. <li data-id="2">save</li>
  5. <li data-id="3">restore</li>
  6. </ul>
  7. ```

  1. ``` js
  2. Sortable.create(el, {
  3. group: "localStorage-example",
  4. store: {
  5.   /**
  6.    * Get the order of elements. Called once during initialization.
  7.    * @param   {Sortable}  sortable
  8.    * @returns {Array}
  9.    */
  10.   get: function (sortable) {
  11.    var order = localStorage.getItem(;
  12.    return order ? order.split('|') : [];
  13.   },

  14.   /**
  15.    * Save the order of elements. Called onEnd (when the item is dropped).
  16.    * @param {Sortable}  sortable
  17.    */
  18.   set: function (sortable) {
  19.    var order = sortable.toArray();
  20.    localStorage.setItem(, order.join('|'));
  21.   }
  22. }
  23. })
  24. ```



  1. ``` html
  2. <link rel="stylesheet" href=""/>
  3. <script src=""></script>
  4. <ul id="simpleList" class="list-group">
  5. <li class="list-group-item">This is <a href="">Sortable</a></li>
  6. <li class="list-group-item">It works with Bootstrap...</li>
  7. <li class="list-group-item">...out of the box.</li>
  8. <li class="list-group-item">It has support for touch devices.</li>
  9. <li class="list-group-item">Just drag some elements around.</li>
  10. </ul>
  11. <script>
  12.     // Simple list
  13.     Sortable.create(simpleList, { /* options */ });
  14. </script>
  15. ```

Static methods & properties

Sortable.create(el:HTMLElement[, options:Object]):Sortable
Create new instance.
The active Sortable instance.

The element being dragged.

The ghost element.

The clone element.

Get the Sortable instance on an element.

Mounts a plugin to Sortable.

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'


Extra Plugins (included in complete versions)

- Swap

Default Plugins (included in default versions)


  1. ``` html
  2. <script src=""></script>
  3. ```

Contributing (Issue/PR)

Please, read this.


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]



Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]


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.