Repository files navigation

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

Demo:http://sortablejs.github.io/Sortable/

• Supports touch devices andmodern browsers (including IE9)
• Can drag from one list to another or within the same list
• CSS animation when moving items
• Supports drag handlesand 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
  • Meteor
  • Angular
    • 2.0+
    • 1.*
  • React
    • ES2015+
    • Mixin
  • Knockout
  • Polymer
  • Vue
  • Ember
• Supports any CSS library, e.g.Bootstrap
• Simple API
• Support forplugins
• CDN
• No jQuery required (but there issupport)
• Typescript definitions at@types/sortablejs

• 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 with NPM:

npm install sortablejs --save

Install with Bower:

bower install --save sortablejs

Import into your project:

// Default SortableJSimportSortablefrom'sortablejs';// Core SortableJS (without default plugins)importSortablefrom'sortablejs/modular/sortable.core.esm.js';// Complete SortableJS (with all plugins)importSortablefrom'sortablejs/modular/sortable.complete.esm.js';

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 justul/li. Here is anexample withdivs.

varsortable=newSortable(el,{group:"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',// HTML attribute that is used by the `toArray()` methodghostClass:"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 itsetData: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}});

To drag elements from one list into another, both lists must have the samegroup 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.

Demo:

• https://jsbin.com/hijetos/edit?js,output
• https://jsbin.com/nacoyah/edit?js,output — use of complex logic in thepull and put
• https://jsbin.com/bifuyab/edit?js,output — userevertClone: true

Allow sorting inside list.

Demo:https://jsbin.com/jayedig/edit?js,output

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.

Demo:https://jsbin.com/zosiwah/edit?js,output

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

Percentage of the target that the swap zone will take up, as a float between0 and1.

Read more

Demo:http://sortablejs.github.io/Sortable#thresholds

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

Read more

Demo:http://sortablejs.github.io/Sortable#thresholds

Percentage of the target that the inverted swap zone will take up, as a float between0 and1. If not given, will default toswapThreshold.

Read more

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

Read more

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';}});

This option is similar tofallbackTolerance option.

When thedelay option is set, some phones with very sensitive touch displays like the Samsung Galaxy S8 will fireunwanted 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.

Disables the sortable if set totrue.

Demo:https://jsbin.com/sewokud/edit?js,output

varsortable=Sortable.create(list);document.getElementById("switcher").onclick=function(){varstate=sortable.option("disabled");// getsortable.option("disabled",!state);// set};

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.

Demo:https://jsbin.com/numakuh/edit?html,js,output

Sortable.create(el,{handle:".my-handle"});

<ul><li><spanclass="my-handle">::</span> list item text one<li><spanclass="my-handle">::</span> list item text two</ul>

.my-handle {cursor: move;cursor: -webkit-grabbing;}

Sortable.create(list,{filter:".js-remove, .js-edit",onFilter:function(evt){varitem=evt.item,ctrl=evt.target;if(Sortable.utils.is(ctrl,".js-remove")){// Click on remove buttonitem.parentNode.removeChild(item);// remove sortable item}elseif(Sortable.utils.is(ctrl,".js-edit")){// Click on edit link// ...}}})

Class name for the drop placeholder (defaultsortable-ghost).

Demo:https://jsbin.com/henuyiw/edit?css,js,output

.ghost {opacity:0.4;}

Sortable.create(list,{ghostClass:"ghost"});

Class name for the chosen item (defaultsortable-chosen).

Demo:https://jsbin.com/hoqufox/edit?css,js,output

.chosen {color:#fff;background-color:#c00;}

Sortable.create(list,{delay:500,chosenClass:"chosen"});

If set totrue, 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 classfallbackClass defined in the options. This behaviour controls the look of this 'dragged' Element.

Demo:https://jsbin.com/sibiput/edit?html,css,js,output

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.

If set totrue, 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, orcan 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 betrue for nested sortables to work.

If set tofalse, the clone is hidden by having it's CSSdisplay property set tonone.By default, this option istrue, meaning Sortable will remove the cloned element from the DOM when it is supposed to be hidden.

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 to5. Set to0 to disable this feature.

Demo:https://jsbin.com/becavoj/edit?js,output

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

For example:

ul:empty {padding-bottom:20px;}

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

Demo:https://jsbin.com/yunakeg/edit?html,css,js,output

• 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 —true if will element be inserted after target (orfalse if before)

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 itemdata-id's (dataIdAttr option) into an array of string.

Sorts the elements according to the array.

varorder=sortable.toArray();sortable.sort(order.reverse(),true);// apply

Save the current sorting (seestore)

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('|'));}}})

Demo:https://jsbin.com/visimub/edit?html,js,output

<!-- Latest compiled and minified CSS --><linkrel="stylesheet"href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css"/><!-- Latest Sortable --><scriptsrc="http://SortableJS.github.io/Sortable/Sortable.js"></script><!-- Simple List --><ulid="simpleList"class="list-group"><liclass="list-group-item">This is<ahref="http://SortableJS.github.io/Sortable/">Sortable</a></li><liclass="list-group-item">It works with Bootstrap...</li><liclass="list-group-item">...out of the box.</li><liclass="list-group-item">It has support for touch devices.</li><liclass="list-group-item">Just drag some elements around.</li></ul><script>// Simple listSortable.create(simpleList,{/* options */});</script>

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 thedirection of the element as either'vertical' or'horizontal'
• index(el:HTMLElement, selector:String):Number — index of the element within its parent for a selected set of elements
• getChild(el:HTMLElement, childNum:Number, options:Object, includeDragEl:Boolean):HTMLElement — get the draggable element at a given index of draggable elements within a Sortable instance
• expando:String — expando property name for internal use, sortableListElement[expando] returns the Sortable instance of that elemenet

• MultiDrag
• Swap

• AutoScroll
• OnSpill

<!-- 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]

Permission is hereby granted, free of charge, to any person obtaininga copy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall beincluded 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 OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BELIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIONOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTIONWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.