Sortable is a JavaScript library for reorderable drag-and-drop lists.
Demo: http://sortablejs.github.io/Sortable/
todo: add entrypoints table around here somewhere.
It was never fully supported, but we've decided to consciously deprecate the use of fetching files directly from GitHub.
This came to our attention when a few tutorials out on the web (we thank you!) which instruct to import SortableJS directly from our GitHub source repository. GitHub is used to develop Sortable, not host it.
The correct way to consume sortable in a HTML script is to use an officially supported CDN, such as jsdelivr or unpkg.
These files now trigger console.warn with a message to come here:
- modular/sortable.core.esm.js
- modular/sortable.complete.esm.js
- modular/sortable.esm.js
- Sortable.js
- Sortable.min.js
Bower has been deprecated, which means we will no longer support it. Please replace your usage of bower with npm, yarn or a javascript package manager of your choice.
- 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
- CDN
- No jQuery required (but there is support)
- Typescript definitions via @types/sortablejs
There are many bindings for SortableJS to use with your favourite frameworks and libraries:
- 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)
Install via command line using yarn or npm.
# npm
npm install sortablejs --save
# yarn v1.x
yarn add -D sortablejsImport into your project:
// Default SortableJSimportSortablefrom"sortablejs";import{Sortable,MultiDrag,Swap,OnSpill,AutoScroll}from"sortablejs";Cherrypick plugins:
// Cherrypick extra pluginsimportSortable,{MultiDrag,Swap}from"sortablejs";Sortable.mount(newMultiDrag(),newSwap());// Cherrypick default pluginsimportSortable,{AutoScroll}from"sortablejs/modular/sortable.core.esm.js";Sortable.mount(newAutoScroll());<ulid="items"><li>item 1</li><li>item 2</li><li>item 3</li></ul>varel=document.getElementById("items");varsortable=Sortable.create(el);You can use any element for the list and its elements, not just ul/li. Here is an example with divs.
Here we've summarised the options with their default values example values. More details available in the docs/sortable-options
varsortable=newSortable(el,{// variablesgroup: "name",// or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }sort: true,// sorting inside listdelay: 0,// time in milliseconds to define when the sorting should startdelayOnTouchOnly: false,// only delay if user is using touchtouchStartThreshold: 0,// px, how many pixels the point should move before cancelling a delayed drag eventdisabled: false,// Disables the sortable if set to true.store: null,// @see Storeanimation: 150,// ms, animation speed moving items when sorting, `0` — without animationeasing: "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 itemsfilter: ".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 draggabledataIdAttr: "data-id",ghostClass: "sortable-ghost",// Class name for the drop placeholderchosenClass: "sortable-chosen",// Class name for the chosen itemdragClass: "sortable-drag",// Class name for the dragging itemswapThreshold: 1,// Threshold of the swap zoneinvertSwap: false,// Will always use inverted swap zone if set to trueinvertedSwapThreshold: 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 infallbackClass: "sortable-fallback",// Class name for the cloned DOM Element when using forceFallbackfallbackOnBody: false,// Appends the cloned DOM Element into the Document's BodyfallbackTolerance: 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 itemptyInsertThreshold: 5,// px, distance mouse must be from empty sortable to insert drag element into it// handlers/hooks - listen to sortable events here.setData: function(/** DataTransfer */dataTransfer,/** HTMLElement*/dragEl){dataTransfer.setData("Text",dragEl.textContent);// `dataTransfer` object of HTML5 DragEvent},// Element is chosenonChoose: function(/**Event*/evt){evt.oldIndex;// element index within parent},// Element is unchosenonUnchoose: function(/**Event*/evt){// same properties as onEnd},// Element dragging startedonStart: function(/**Event*/evt){evt.oldIndex;// element index within parent},// Element dragging endedonEnd: function(/**Event*/evt){varitemEl=evt.item;// dragged HTMLElementevt.to;// target listevt.from;// previous listevt.oldIndex;// element's old index within old parentevt.newIndex;// element's new index within new parentevt.oldDraggableIndex;// element's old index within old parent, only counting draggable elementsevt.newDraggableIndex;// element's new index within new parent, only counting draggable elementsevt.clone;// the clone elementevt.pullMode;// when item is in another sortable: `"clone"` if cloning, `true` if moving},// Element is dropped into the list from another listonAdd: function(/**Event*/evt){// same properties as onEnd},// Changed sorting within listonUpdate: 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 listonRemove: function(/**Event*/evt){// same properties as onEnd},// Attempt to drag a filtered elementonFilter: function(/**Event*/evt){varitemEl=evt.item;// HTMLElement receiving the `mousedown|tapstart` event.},// Event when you move an item in the list or between listsonMove: function(/**Event*/evt,/**Event*/originalEvent){// Example: https://jsbin.com/nawahef/edit?js,outputevt.dragged;// dragged HTMLElementevt.draggedRect;// DOMRect {left, top, right, bottom}evt.related;// HTMLElement on which have guidedevt.relatedRect;// DOMRectevt.willInsertAfter;// Boolean that is true if Sortable will insert drag element after target by defaultoriginalEvent.clientY;// mouse position// return false; — for cancel// return -1; — insert before target// return 1; — insert after target// return true; — keep default insertion point based on the direction// return void; — keep default insertion point based on the direction},// Called when creating a clone of elementonClone: function(/**Event*/evt){varorigEl=evt.item;varcloneEl=evt.clone;},// Called when dragging element changes positiononChange: 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},});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 - dragged:
HTMLElement - draggedRect:
DOMRect - related:
HTMLElement— element on which have guided - relatedRect:
DOMRect - willInsertAfter:
Boolean—trueif will element be inserted after target (orfalseif before)
These are available on each Sortable instance (the return value of new Sortable({}))
Get or set the option.
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.
varorder=sortable.toArray();sortable.sort(order.reverse());// applySave the current sorting (see store)
Removes the sortable functionality completely.
Saving and restoring of the sort.
<ul><lidata-id="1">order</li><lidata-id="2">save</li><lidata-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){varorder=localStorage.getItem(sortable.options.group.name);returnorder ? order.split("|") : [];},/** * Save the order of elements. Called onEnd (when the item is dropped). * @param {Sortable} sortable */set: function(sortable){varorder=sortable.toArray();localStorage.setItem(sortable.options.group.name,order.join("|"));},},});todo: overview of Sortable API Surface
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'
<!-- jsDelivr :: Sortable :: Latest (https://www.jsdelivr.com/package/npm/sortablejs) --><scriptsrc="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>Please, read this.
This project exists thanks to all the people who contribute. [Contribute].
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]
