README.md 26.2 KB
Newer Older
J
jess 已提交
1
# Sortable   [![Financial Contributors on Open Collective](https://opencollective.com/Sortable/all/badge.svg?label=financial+contributors)](https://opencollective.com/Sortable) [![CircleCI](https://circleci.com/gh/SortableJS/Sortable.svg?style=svg)](https://circleci.com/gh/SortableJS/Sortable) [![DeepScan grade](https://deepscan.io/api/teams/3901/projects/5666/branches/43977/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=3901&pid=5666&bid=43977) [![](https://data.jsdelivr.com/v1/package/npm/sortablejs/badge)](https://www.jsdelivr.com/package/npm/sortablejs) [![npm](https://img.shields.io/npm/v/sortablejs.svg)](https://www.npmjs.com/package/sortablejs)
O
owen-m1 已提交
2

O
1.8.0  
owen-m1 已提交
3
Sortable is a JavaScript library for reorderable drag-and-drop lists.
R
RubaXa 已提交
4

O
owen-m1 已提交
5
Demo: http://sortablejs.github.io/Sortable/
D
Dan Dascalescu 已提交
6

O
owen-m1 已提交
7
[<img width="250px" src="https://raw.githubusercontent.com/SortableJS/Sortable/HEAD/st/saucelabs.svg?sanitize=true">](https://saucelabs.com/)
R
RubaXa 已提交
8

R
RubaXa 已提交
9
## Features
R
RubaXa 已提交
10

R
+ IE9  
RubaXa 已提交
11
 * Supports touch devices and [modern](http://caniuse.com/#search=drag) browsers (including IE9)
R
RubaXa 已提交
12
 * Can drag from one list to another or within the same list
13
 * CSS animation when moving items
R
RubaXa 已提交
14
 * Supports drag handles *and selectable text* (better than voidberg's html5sortable)
R
RubaXa 已提交
15
 * Smart auto-scrolling
O
1.8.0  
owen-m1 已提交
16
 * Advanced swap detection
O
owen-m1 已提交
17
 * Smooth animations
O
owen-m1 已提交
18
 * [Multi-drag](https://github.com/SortableJS/Sortable/tree/master/plugins/MultiDrag) support
19
 * Support for CSS transforms
20
 * Built using native HTML5 drag and drop API
21
 * Supports
I
Ibrahim 已提交
22
   * [Meteor](https://github.com/SortableJS/meteor-sortablejs)
23
   * Angular
I
Ibrahim 已提交
24
     * [2.0+](https://github.com/SortableJS/angular-sortablejs)
O
owen-m1 已提交
25
     * [1.&ast;](https://github.com/SortableJS/angular-legacy-sortablejs)
I
Ibrahim 已提交
26 27 28 29 30 31
   * React
     * [ES2015+](https://github.com/SortableJS/react-sortablejs)
     * [Mixin](https://github.com/SortableJS/react-mixin-sortablejs)
   * [Knockout](https://github.com/SortableJS/knockout-sortablejs)
   * [Polymer](https://github.com/SortableJS/polymer-sortablejs)
   * [Vue](https://github.com/SortableJS/Vue.Draggable)
32
   * [Ember](https://github.com/SortableJS/ember-sortablejs)
33
 * Supports any CSS library, e.g. [Bootstrap](#bs)
34
 * Simple API
O
owen-m1 已提交
35
 * Support for [plugins](#plugins)
R
RubaXa 已提交
36
 * [CDN](#cdn)
O
owen-m1 已提交
37
 * No jQuery required (but there is [support](https://github.com/SortableJS/jquery-sortablejs))
W
Wayne Van Son 已提交
38
 * Typescript definitions at `@types/sortablejs`
R
RubaXa 已提交
39 40


L
Lebedev Konstantin 已提交
41
<br/>
L
Lebedev Konstantin 已提交
42 43 44


### Articles
R
RubaXa 已提交
45

O
owen-m1 已提交
46
 * [Dragging Multiple Items in Sortable](https://github.com/SortableJS/Sortable/wiki/Dragging-Multiple-Items-in-Sortable) (April 26, 2019)
O
owen-m1 已提交
47
 * [Swap Thresholds and Direction](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction) (December 2, 2018)
O
owen-m1 已提交
48 49
 * [Sortable v1.0 — New capabilities](https://github.com/SortableJS/Sortable/wiki/Sortable-v1.0-—-New-capabilities/) (December 22, 2014)
 * [Sorting with the help of HTML5 Drag'n'Drop API](https://github.com/SortableJS/Sortable/wiki/Sorting-with-the-help-of-HTML5-Drag'n'Drop-API/) (December 23, 2013)
L
Lebedev Konstantin 已提交
50

L
Lebedev Konstantin 已提交
51
<br/>
L
Lebedev Konstantin 已提交
52

O
owen-m1 已提交
53
### Getting Started
S
Steve Perry 已提交
54

O
owen-m1 已提交
55
Install with NPM:
S
Steve Perry 已提交
56 57 58 59
```bash
$ npm install sortablejs --save
```

O
owen-m1 已提交
60
Install with Bower:
S
Steve Perry 已提交
61 62 63 64
```bash
$ bower install --save sortablejs
```

O
owen-m1 已提交
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
Import into your project:
```js
// 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:
```js
// Cherrypick extra plugins
import Sortable, { MultiDrag, Swap } from 'sortablejs';

O
owen-m1 已提交
82
Sortable.mount(new MultiDrag(), new Swap());
O
owen-m1 已提交
83 84 85 86 87


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

O
owen-m1 已提交
88
Sortable.mount(new AutoScroll());
O
owen-m1 已提交
89 90 91 92 93
```


---

L
Lebedev Konstantin 已提交
94

R
RubaXa 已提交
95 96 97 98 99 100 101 102 103 104
### Usage
```html
<ul id="items">
	<li>item 1</li>
	<li>item 2</li>
	<li>item 3</li>
</ul>
```

```js
R
* upd  
RubaXa 已提交
105
var el = document.getElementById('items');
R
RubaXa 已提交
106
var sortable = Sortable.create(el);
R
RubaXa 已提交
107 108
```

O
owen-m1 已提交
109
You can use any element for the list and its elements, not just `ul`/`li`. Here is an [example with `div`s](https://jsbin.com/visimub/edit?html,js,output).
110

R
RubaXa 已提交
111

R
* upd  
RubaXa 已提交
112 113 114
---


R
RubaXa 已提交
115 116
### Options
```js
D
Dano Alexander 已提交
117
var sortable = new Sortable(el, {
O
owen-m1 已提交
118
	group: "name",  // or { name: "...", pull: [true, false, 'clone', array], put: [true, false, array] }
119
	sort: true,  // sorting inside list
R
RubaXa 已提交
120
	delay: 0, // time in milliseconds to define when the sorting should start
121
	delayOnTouchOnly: false, // only delay if user is using touch
122
	touchStartThreshold: 0, // px, how many pixels the point should move before cancelling a delayed drag event
R
RubaXa 已提交
123
	disabled: false, // Disables the sortable if set to true.
124 125
	store: null,  // @see Store
	animation: 150,  // ms, animation speed moving items when sorting, `0` — without animation
O
1.8.0  
owen-m1 已提交
126
	easing: "cubic-bezier(1, 0, 0, 1)", // Easing for animation. Defaults to null. See https://easings.net/ for examples.
127
	handle: ".my-handle",  // Drag handle selector within list items
D
Dan Dascalescu 已提交
128
	filter: ".ignore-elements",  // Selectors that do not lead to dragging (String or Function)
L
Lebedev Konstantin 已提交
129
	preventOnFilter: true, // Call `event.preventDefault()` when triggered `filter`
A
Andrey Tkachenko 已提交
130
	draggable: ".item",  // Specifies which items inside the element should be draggable
O
owen-m1 已提交
131

O
owen-m1 已提交
132
	dataIdAttr: 'data-id', // HTML attribute that is used by the `toArray()` method
O
owen-m1 已提交
133

134
	ghostClass: "sortable-ghost",  // Class name for the drop placeholder
R
RubaXa 已提交
135
	chosenClass: "sortable-chosen",  // Class name for the chosen item
R
RubaXa 已提交
136
	dragClass: "sortable-drag",  // Class name for the dragging item
137

O
owen-m1 已提交
138 139 140 141 142
	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)

C
ChiefORZ 已提交
143
	forceFallback: false,  // ignore the HTML5 DnD behaviour and force the fallback to kick in
L
Lebedev Konstantin 已提交
144

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

O
owen-m1 已提交
149
	dragoverBubble: false,
O
1.8.0  
owen-m1 已提交
150 151 152
	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

O
owen-m1 已提交
153

L
Lebedev Konstantin 已提交
154 155
	setData: function (/** DataTransfer */dataTransfer, /** HTMLElement*/dragEl) {
		dataTransfer.setData('Text', dragEl.textContent); // `dataTransfer` object of HTML5 DragEvent
R
RubaXa 已提交
156
	},
157

T
TaliLavi 已提交
158 159 160 161 162
	// Element is chosen
	onChoose: function (/**Event*/evt) {
		evt.oldIndex;  // element index within parent
	},

O
1.8.0  
owen-m1 已提交
163 164 165 166 167
	// Element is unchosen
	onUnchoose: function(/**Event*/evt) {
		// same properties as onEnd
	},

T
TaliLavi 已提交
168
	// Element dragging started
169 170 171
	onStart: function (/**Event*/evt) {
		evt.oldIndex;  // element index within parent
	},
172

T
TaliLavi 已提交
173
	// Element dragging ended
174
	onEnd: function (/**Event*/evt) {
175 176 177 178 179
		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
180 181
		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
182 183
		evt.clone // the clone element
		evt.pullMode;  // when item is in another sortable: `"clone"` if cloning, `true` if moving
184
	},
R
RubaXa 已提交
185

186
	// Element is dropped into the list from another list
187
	onAdd: function (/**Event*/evt) {
188
		// same properties as onEnd
R
RubaXa 已提交
189 190
	},

191
	// Changed sorting within list
192
	onUpdate: function (/**Event*/evt) {
193
		// same properties as onEnd
R
RubaXa 已提交
194 195
	},

196
	// Called by any change to the list (add / update / remove)
197
	onSort: function (/**Event*/evt) {
198
		// same properties as onEnd
199 200
	},

201
	// Element is removed from the list into another list
202
	onRemove: function (/**Event*/evt) {
203
		// same properties as onEnd
204 205
	},

206
	// Attempt to drag a filtered element
207 208
	onFilter: function (/**Event*/evt) {
		var itemEl = evt.item;  // HTMLElement receiving the `mousedown|tapstart` event.
R
RubaXa 已提交
209
	},
210

R
RubaXa 已提交
211
	// Event when you move an item in the list or between lists
212
	onMove: function (/**Event*/evt, /**Event*/originalEvent) {
O
owen-m1 已提交
213
		// Example: https://jsbin.com/nawahef/edit?js,output
R
RubaXa 已提交
214
		evt.dragged; // dragged HTMLElement
O
1.8.0  
owen-m1 已提交
215
		evt.draggedRect; // DOMRect {left, top, right, bottom}
R
RubaXa 已提交
216
		evt.related; // HTMLElement on which have guided
O
1.8.0  
owen-m1 已提交
217 218
		evt.relatedRect; // DOMRect
		evt.willInsertAfter; // Boolean that is true if Sortable will insert drag element after target by default
219
		originalEvent.clientY; // mouse position
220
		// return false; — for cancel
O
1.8.0  
owen-m1 已提交
221 222
		// return -1; — insert before target
		// return 1; — insert after target
O
owen-m1 已提交
223 224
		// return true; — keep default insertion point based on the direction
		// return void; — keep default insertion point based on the direction
R
RubaXa 已提交
225
	},
226

R
RubaXa 已提交
227 228 229 230
	// Called when creating a clone of element
	onClone: function (/**Event*/evt) {
		var origEl = evt.item;
		var cloneEl = evt.clone;
O
1.8.0  
owen-m1 已提交
231 232 233 234 235 236
	},

	// 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
R
RubaXa 已提交
237 238 239
	}
});
```
R
RubaXa 已提交
240

R
RubaXa 已提交
241

R
* upd  
RubaXa 已提交
242 243
---

R
RubaXa 已提交
244

245 246 247
#### `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.
R
RubaXa 已提交
248

249
 * name: `String` — group name
O
owen-m1 已提交
250
 * 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`.
O
1.8.0  
owen-m1 已提交
251
 * 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.
L
Lebedev Konstantin 已提交
252 253
 * revertClone: `boolean` — revert cloned element to initial position after moving to a another list.

R
RubaXa 已提交
254 255

Demo:
O
owen-m1 已提交
256 257 258
 - https://jsbin.com/hijetos/edit?js,output
 - https://jsbin.com/nacoyah/edit?js,output — use of complex logic in the `pull` and` put`
 - https://jsbin.com/bifuyab/edit?js,output — use `revertClone: true`
R
RubaXa 已提交
259 260 261 262


---

263

R
RubaXa 已提交
264
#### `sort` option
O
owen-m1 已提交
265
Allow sorting inside list.
R
RubaXa 已提交
266

O
owen-m1 已提交
267
Demo: https://jsbin.com/jayedig/edit?js,output
R
RubaXa 已提交
268 269 270 271 272


---


R
RubaXa 已提交
273
#### `delay` option
R
RubaXa 已提交
274
Time in milliseconds to define when the sorting should start.
275
Unfortunately, due to browser restrictions, delaying is not possible on IE or Edge with native drag & drop.
R
RubaXa 已提交
276

O
owen-m1 已提交
277
Demo: https://jsbin.com/zosiwah/edit?js,output
R
RubaXa 已提交
278 279 280 281 282


---


283 284 285 286 287 288 289
#### `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`.


---


O
owen-m1 已提交
290
#### `swapThreshold` option
O
owen-m1 已提交
291
Percentage of the target that the swap zone will take up, as a float between `0` and `1`.
O
owen-m1 已提交
292

O
owen-m1 已提交
293
[Read more](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction#swap-threshold)
O
owen-m1 已提交
294

O
1.8.0  
owen-m1 已提交
295 296
Demo: http://sortablejs.github.io/Sortable#thresholds

O
owen-m1 已提交
297 298 299 300 301

---


#### `invertSwap` option
O
owen-m1 已提交
302
Set to `true` to set the swap zone to the sides of the target, for the effect of sorting "in between" items.
O
owen-m1 已提交
303

O
owen-m1 已提交
304
[Read more](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction#forcing-inverted-swap-zone)
O
owen-m1 已提交
305

O
1.8.0  
owen-m1 已提交
306 307
Demo: http://sortablejs.github.io/Sortable#thresholds

O
owen-m1 已提交
308 309 310 311 312

---


#### `invertedSwapThreshold` option
O
owen-m1 已提交
313
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`.
O
owen-m1 已提交
314

O
owen-m1 已提交
315
[Read more](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction#dealing-with-swap-glitching)
O
owen-m1 已提交
316 317 318 319 320 321 322 323


---


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

O
owen-m1 已提交
324
[Read more](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction#direction)
O
owen-m1 已提交
325 326


O
1.8.0  
owen-m1 已提交
327
Example of direction detection for vertical list that includes full column and half column elements:
O
owen-m1 已提交
328 329 330 331

```js
Sortable.create(el, {
	direction: function(evt, target, dragEl) {
O
1.8.0  
owen-m1 已提交
332 333 334 335
		if (target !== null && target.className.includes('half-column') && dragEl.className.includes('half-column')) {
			return 'horizontal';
		}
		return 'vertical';
O
owen-m1 已提交
336 337 338 339 340 341 342 343
	}
});
```


---


344
#### `touchStartThreshold` option
345 346
This option is similar to `fallbackTolerance` option.

347
When the `delay` option is set, some phones with very sensitive touch displays like the Samsung Galaxy S8 will fire
348 349 350 351 352 353 354 355 356 357
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.


---


R
RubaXa 已提交
358 359 360
#### `disabled` options
Disables the sortable if set to `true`.

O
owen-m1 已提交
361
Demo: https://jsbin.com/sewokud/edit?js,output
R
RubaXa 已提交
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

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

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

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


---


R
RubaXa 已提交
377 378 379 380 381
#### `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.

O
owen-m1 已提交
382
Demo: https://jsbin.com/numakuh/edit?html,js,output
R
RubaXa 已提交
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407

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

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

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


---


R
RubaXa 已提交
408 409 410 411 412 413 414
#### `filter` option


```js
Sortable.create(list, {
	filter: ".js-remove, .js-edit",
	onFilter: function (evt) {
415
		var item = evt.item,
R
RubaXa 已提交
416
			ctrl = evt.target;
R
RubaXa 已提交
417

R
RubaXa 已提交
418 419
		if (Sortable.utils.is(ctrl, ".js-remove")) {  // Click on remove button
			item.parentNode.removeChild(item); // remove sortable item
R
RubaXa 已提交
420
		}
R
RubaXa 已提交
421
		else if (Sortable.utils.is(ctrl, ".js-edit")) {  // Click on edit link
R
RubaXa 已提交
422 423 424 425 426 427 428 429 430 431
			// ...
		}
	}
})
```


---


432
#### `ghostClass` option
R
RubaXa 已提交
433
Class name for the drop placeholder (default `sortable-ghost`).
434

O
owen-m1 已提交
435
Demo: https://jsbin.com/henuyiw/edit?css,js,output
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452

```css
.ghost {
  opacity: 0.4;
}
```

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


---


R
RubaXa 已提交
453 454 455
#### `chosenClass` option
Class name for the chosen item  (default `sortable-chosen`).

O
owen-m1 已提交
456
Demo: https://jsbin.com/hoqufox/edit?css,js,output
R
RubaXa 已提交
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

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

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


---


C
ChiefORZ 已提交
476 477
#### `forceFallback` option
If set to `true`, the Fallback for non HTML5 Browser will be used, even if we are using an HTML5 Browser.
P
Prayag Verma 已提交
478
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.
479

P
Prayag Verma 已提交
480
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.
481

O
owen-m1 已提交
482
Demo: https://jsbin.com/sibiput/edit?html,css,js,output
483 484 485 486 487


---


488 489 490 491
#### `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.

492
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.
493 494 495 496 497 498 499 500
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.


---


O
owen-m1 已提交
501
#### `dragoverBubble` option
O
1.8.0  
owen-m1 已提交
502 503 504 505 506 507 508 509 510 511 512 513
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.
O
owen-m1 已提交
514 515 516 517 518


---


O
1.8.0  
owen-m1 已提交
519 520 521 522 523
#### `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.

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

O
Owen M 已提交
524
An alternative to this option would be to set a padding on your list when it is empty.
O
Owen M 已提交
525

O
Owen M 已提交
526
For example:
O
Owen M 已提交
527 528
```css
ul:empty {
O
Owen M 已提交
529
  padding-bottom: 20px;
O
Owen M 已提交
530 531
}
```
Y
Yopai 已提交
532

O
Owen M 已提交
533
Warning: For `:empty` to work, it must have no node inside (even text one).
Y
Yopai 已提交
534

O
Owen M 已提交
535 536
Demo:
https://jsbin.com/yunakeg/edit?html,css,js,output
O
1.8.0  
owen-m1 已提交
537 538

---
O
owen-m1 已提交
539
### Event object ([demo](https://jsbin.com/fogujiv/edit?js,output))
R
* UPD  
RubaXa 已提交
540

O
1.8.0  
owen-m1 已提交
541
 - to:`HTMLElement` — list, in which moved element
R
* UPD  
RubaXa 已提交
542 543 544 545 546
 - from:`HTMLElement` — previous list
 - item:`HTMLElement` — dragged element
 - clone:`HTMLElement`
 - oldIndex:`Number|undefined` — old index within parent
 - newIndex:`Number|undefined` — new index within parent
547 548
 - oldDraggableIndex: `Number|undefined` — old index within parent, only counting draggable elements
 - newDraggableIndex: `Number|undefined` — new index within parent, only counting draggable elements
549
 - pullMode:`String|Boolean|undefined` — Pull mode if dragging into another sortable (`"clone"`, `true`, or `false`), otherwise undefined
R
* UPD  
RubaXa 已提交
550 551 552 553 554 555


#### `move` event object
 - to:`HTMLElement`
 - from:`HTMLElement`
 - dragged:`HTMLElement`
O
1.8.0  
owen-m1 已提交
556
 - draggedRect:`DOMRect`
R
* UPD  
RubaXa 已提交
557
 - related:`HTMLElement` — element on which have guided
O
1.8.0  
owen-m1 已提交
558 559
 - relatedRect:`DOMRect`
 - willInsertAfter:`Boolean``true` if will element be inserted after target (or `false` if before)
R
* UPD  
RubaXa 已提交
560 561 562 563 564


---


O
owen-m1 已提交
565
### Methods
566

567 568 569 570 571

##### option(name:`String`[, value:`*`]):`*`
Get or set the option.


572

573
##### closest(el:`HTMLElement`[, selector:`String`]):`HTMLElement|null`
574 575 576
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.


577
##### toArray():`String[]`
R
RubaXa 已提交
578
Serializes the sortable's item `data-id`'s (`dataIdAttr` option) into an array of string.
579 580


581
##### sort(order:`String[]`, useAnimation:`Boolean`)
582
Sorts the elements according to the array.
583

584
```js
R
* upd  
RubaXa 已提交
585
var order = sortable.toArray();
586
sortable.sort(order.reverse(), true); // apply
587 588 589
```


R
RubaXa 已提交
590 591 592 593
##### save()
Save the current sorting (see [store](#store))


594
##### destroy()
595
Removes the sortable functionality completely.
596 597 598 599 600


---


R
RubaXa 已提交
601
<a name="store"></a>
602 603 604
### Store
Saving and restoring of the sort.

605 606 607 608 609 610 611 612
```html
<ul>
	<li data-id="1">order</li>
	<li data-id="2">save</li>
	<li data-id="3">restore</li>
</ul>
```

613
```js
614
Sortable.create(el, {
615 616
	group: "localStorage-example",
	store: {
R
* JSDoc  
RubaXa 已提交
617 618 619
		/**
		 * Get the order of elements. Called once during initialization.
		 * @param   {Sortable}  sortable
D
Dan Dascalescu 已提交
620
		 * @returns {Array}
R
* JSDoc  
RubaXa 已提交
621
		 */
622
		get: function (sortable) {
古谷向日葵 已提交
623
			var order = localStorage.getItem(sortable.options.group.name);
624 625 626
			return order ? order.split('|') : [];
		},

R
* JSDoc  
RubaXa 已提交
627
		/**
D
Dan Dascalescu 已提交
628
		 * Save the order of elements. Called onEnd (when the item is dropped).
R
* JSDoc  
RubaXa 已提交
629 630
		 * @param {Sortable}  sortable
		 */
631 632
		set: function (sortable) {
			var order = sortable.toArray();
古谷向日葵 已提交
633
			localStorage.setItem(sortable.options.group.name, order.join('|'));
634 635 636 637 638 639
		}
	}
})
```


R
RubaXa 已提交
640 641 642 643 644
---


<a name="bs"></a>
### Bootstrap
O
owen-m1 已提交
645
Demo: https://jsbin.com/visimub/edit?html,js,output
R
RubaXa 已提交
646 647 648 649 650 651 652

```html
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css"/>


<!-- Latest Sortable -->
O
owen-m1 已提交
653
<script src="http://SortableJS.github.io/Sortable/Sortable.js"></script>
R
RubaXa 已提交
654 655 656 657


<!-- Simple List -->
<ul id="simpleList" class="list-group">
O
owen-m1 已提交
658
	<li class="list-group-item">This is <a href="http://SortableJS.github.io/Sortable/">Sortable</a></li>
R
RubaXa 已提交
659 660 661 662 663 664 665 666 667 668
	<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>
D
Dano Alexander 已提交
669
```
670

R
RubaXa 已提交
671

R
RubaXa 已提交
672 673 674
---


R
RubaXa 已提交
675 676 677 678 679 680 681 682 683 684 685 686
### Static methods & properties



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


---


##### Sortable.active:`Sortable`
O
owen-m1 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
The active Sortable instance.


---


##### Sortable.dragged:`HTMLElement`
The element being dragged.


---


##### Sortable.ghost:`HTMLElement`
The ghost element.


---


##### Sortable.clone:`HTMLElement`
The clone element.


---


O
owen-m1 已提交
714 715 716 717 718 719 720 721
##### Sortable.get(element:`HTMLElement`):`Sortable`
Get the Sortable instance on an element.


---


##### Sortable.mount(plugin:`...SortablePlugin|SortablePlugin[]`)
O
owen-m1 已提交
722
Mounts a plugin to Sortable.
R
RubaXa 已提交
723 724 725 726


---

R
RubaXa 已提交
727

R
RubaXa 已提交
728
##### Sortable.utils
R
RubaXa 已提交
729 730 731 732 733 734 735 736
* 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
R
RubaXa 已提交
737
* is(el`:HTMLElement`, selector`:String`)`:Boolean` — check the current matched set of elements against a selector
R
RubaXa 已提交
738
* 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
739
* clone(el`:HTMLElement`)`:HTMLElement` — create a deep copy of the set of matched elements
R
RubaXa 已提交
740
* toggleClass(el`:HTMLElement`, name`:String`, state`:Boolean`) — add or remove one classes from each element
O
1.8.0  
owen-m1 已提交
741
* detectDirection(el`:HTMLElement`)`:String` — automatically detect the [direction](https://github.com/SortableJS/Sortable/wiki/Swap-Thresholds-and-Direction#direction) of the element as either `'vertical'` or `'horizontal'`
B
Bitdeli Chef 已提交
742

L
Lebedev Konstantin 已提交
743

R
RubaXa 已提交
744 745 746
---


O
owen-m1 已提交
747 748 749 750 751 752 753 754 755 756 757 758 759
### Plugins
#### Extra Plugins (included in complete versions)
 - [MultiDrag](https://github.com/SortableJS/Sortable/tree/master/plugins/MultiDrag)
 - [Swap](https://github.com/SortableJS/Sortable/tree/master/plugins/Swap)

#### Default Plugins (included in default versions)
 - [AutoScroll](https://github.com/SortableJS/Sortable/tree/master/plugins/AutoScroll)
 - [OnSpill](https://github.com/SortableJS/Sortable/tree/master/plugins/OnSpill)


---


R
RubaXa 已提交
760 761 762 763
<a name="cdn"></a>
### CDN

```html
D
ddett 已提交
764 765
<!-- jsDelivr :: Sortable :: Latest (https://www.jsdelivr.com/package/npm/sortablejs) -->
<script src="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>
R
RubaXa 已提交
766 767
```

R
RubaXa 已提交
768

L
Lebedev Konstantin 已提交
769 770 771
---


R
RubaXa 已提交
772 773
### Contributing (Issue/PR)

774
Please, [read this](CONTRIBUTING.md).
R
RubaXa 已提交
775 776 777 778 779


---


J
jess 已提交
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/SortableJS/Sortable/graphs/contributors"><img src="https://opencollective.com/Sortable/contributors.svg?width=890&button=false" /></a>

### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/Sortable/contribute)]

#### Individuals

<a href="https://opencollective.com/Sortable"><img src="https://opencollective.com/Sortable/individuals.svg?width=890"></a>

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/Sortable/contribute)]

<a href="https://opencollective.com/Sortable/organization/0/website"><img src="https://opencollective.com/Sortable/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/1/website"><img src="https://opencollective.com/Sortable/organization/1/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/2/website"><img src="https://opencollective.com/Sortable/organization/2/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/3/website"><img src="https://opencollective.com/Sortable/organization/3/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/4/website"><img src="https://opencollective.com/Sortable/organization/4/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/5/website"><img src="https://opencollective.com/Sortable/organization/5/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/6/website"><img src="https://opencollective.com/Sortable/organization/6/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/7/website"><img src="https://opencollective.com/Sortable/organization/7/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/8/website"><img src="https://opencollective.com/Sortable/organization/8/avatar.svg"></a>
<a href="https://opencollective.com/Sortable/organization/9/website"><img src="https://opencollective.com/Sortable/organization/9/avatar.svg"></a>

L
Lebedev Konstantin 已提交
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
## 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.