aboutsummaryrefslogtreecommitdiffstats
path: root/library/Sortable/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'library/Sortable/plugins')
-rw-r--r--library/Sortable/plugins/AutoScroll/AutoScroll.js271
-rw-r--r--library/Sortable/plugins/AutoScroll/README.md110
-rw-r--r--library/Sortable/plugins/AutoScroll/index.js1
-rw-r--r--library/Sortable/plugins/MultiDrag/MultiDrag.js618
-rw-r--r--library/Sortable/plugins/MultiDrag/README.md96
-rw-r--r--library/Sortable/plugins/MultiDrag/index.js1
-rw-r--r--library/Sortable/plugins/OnSpill/OnSpill.js79
-rw-r--r--library/Sortable/plugins/OnSpill/README.md60
-rw-r--r--library/Sortable/plugins/OnSpill/index.js1
-rw-r--r--library/Sortable/plugins/README.md178
-rw-r--r--library/Sortable/plugins/Swap/README.md55
-rw-r--r--library/Sortable/plugins/Swap/Swap.js90
-rw-r--r--library/Sortable/plugins/Swap/index.js1
13 files changed, 1561 insertions, 0 deletions
diff --git a/library/Sortable/plugins/AutoScroll/AutoScroll.js b/library/Sortable/plugins/AutoScroll/AutoScroll.js
new file mode 100644
index 000000000..48ac81e28
--- /dev/null
+++ b/library/Sortable/plugins/AutoScroll/AutoScroll.js
@@ -0,0 +1,271 @@
+import {
+ on,
+ off,
+ css,
+ throttle,
+ cancelThrottle,
+ scrollBy,
+ getParentAutoScrollElement,
+ expando,
+ getRect,
+ getWindowScrollingElement
+} from '../../src/utils.js';
+
+import Sortable from '../../src/Sortable.js';
+
+import { Edge, IE11OrLess, Safari } from '../../src/BrowserInfo.js';
+
+let autoScrolls = [],
+ scrollEl,
+ scrollRootEl,
+ scrolling = false,
+ lastAutoScrollX,
+ lastAutoScrollY,
+ touchEvt,
+ pointerElemChangedInterval;
+
+function AutoScrollPlugin() {
+
+ function AutoScroll() {
+ this.defaults = {
+ scroll: true,
+ forceAutoScrollFallback: false,
+ scrollSensitivity: 30,
+ scrollSpeed: 10,
+ bubbleScroll: true
+ };
+
+ // Bind all private methods
+ for (let fn in this) {
+ if (fn.charAt(0) === '_' && typeof this[fn] === 'function') {
+ this[fn] = this[fn].bind(this);
+ }
+ }
+ }
+
+ AutoScroll.prototype = {
+ dragStarted({ originalEvent }) {
+ if (this.sortable.nativeDraggable) {
+ on(document, 'dragover', this._handleAutoScroll);
+ } else {
+ if (this.options.supportPointer) {
+ on(document, 'pointermove', this._handleFallbackAutoScroll);
+ } else if (originalEvent.touches) {
+ on(document, 'touchmove', this._handleFallbackAutoScroll);
+ } else {
+ on(document, 'mousemove', this._handleFallbackAutoScroll);
+ }
+ }
+ },
+
+ dragOverCompleted({ originalEvent }) {
+ // For when bubbling is canceled and using fallback (fallback 'touchmove' always reached)
+ if (!this.options.dragOverBubble && !originalEvent.rootEl) {
+ this._handleAutoScroll(originalEvent);
+ }
+ },
+
+ drop() {
+ if (this.sortable.nativeDraggable) {
+ off(document, 'dragover', this._handleAutoScroll);
+ } else {
+ off(document, 'pointermove', this._handleFallbackAutoScroll);
+ off(document, 'touchmove', this._handleFallbackAutoScroll);
+ off(document, 'mousemove', this._handleFallbackAutoScroll);
+ }
+
+ clearPointerElemChangedInterval();
+ clearAutoScrolls();
+ cancelThrottle();
+ },
+
+ nulling() {
+ touchEvt =
+ scrollRootEl =
+ scrollEl =
+ scrolling =
+ pointerElemChangedInterval =
+ lastAutoScrollX =
+ lastAutoScrollY = null;
+
+ autoScrolls.length = 0;
+ },
+
+ _handleFallbackAutoScroll(evt) {
+ this._handleAutoScroll(evt, true);
+ },
+
+ _handleAutoScroll(evt, fallback) {
+ const x = (evt.touches ? evt.touches[0] : evt).clientX,
+ y = (evt.touches ? evt.touches[0] : evt).clientY,
+
+ elem = document.elementFromPoint(x, y);
+
+ touchEvt = evt;
+
+ // IE does not seem to have native autoscroll,
+ // Edge's autoscroll seems too conditional,
+ // MACOS Safari does not have autoscroll,
+ // Firefox and Chrome are good
+ if (fallback || this.options.forceAutoScrollFallback || Edge || IE11OrLess || Safari) {
+ autoScroll(evt, this.options, elem, fallback);
+
+ // Listener for pointer element change
+ let ogElemScroller = getParentAutoScrollElement(elem, true);
+ if (
+ scrolling &&
+ (
+ !pointerElemChangedInterval ||
+ x !== lastAutoScrollX ||
+ y !== lastAutoScrollY
+ )
+ ) {
+ pointerElemChangedInterval && clearPointerElemChangedInterval();
+ // Detect for pointer elem change, emulating native DnD behaviour
+ pointerElemChangedInterval = setInterval(() => {
+ let newElem = getParentAutoScrollElement(document.elementFromPoint(x, y), true);
+ if (newElem !== ogElemScroller) {
+ ogElemScroller = newElem;
+ clearAutoScrolls();
+ }
+ autoScroll(evt, this.options, newElem, fallback);
+ }, 10);
+ lastAutoScrollX = x;
+ lastAutoScrollY = y;
+ }
+ } else {
+ // if DnD is enabled (and browser has good autoscrolling), first autoscroll will already scroll, so get parent autoscroll of first autoscroll
+ if (!this.options.bubbleScroll || getParentAutoScrollElement(elem, true) === getWindowScrollingElement()) {
+ clearAutoScrolls();
+ return;
+ }
+ autoScroll(evt, this.options, getParentAutoScrollElement(elem, false), false);
+ }
+ }
+ };
+
+ return Object.assign(AutoScroll, {
+ pluginName: 'scroll',
+ initializeByDefault: true
+ });
+}
+
+function clearAutoScrolls() {
+ autoScrolls.forEach(function(autoScroll) {
+ clearInterval(autoScroll.pid);
+ });
+ autoScrolls = [];
+}
+
+function clearPointerElemChangedInterval() {
+ clearInterval(pointerElemChangedInterval);
+}
+
+
+const autoScroll = throttle(function(evt, options, rootEl, isFallback) {
+ // Bug: https://bugzilla.mozilla.org/show_bug.cgi?id=505521
+ if (!options.scroll) return;
+ const x = (evt.touches ? evt.touches[0] : evt).clientX,
+ y = (evt.touches ? evt.touches[0] : evt).clientY,
+ sens = options.scrollSensitivity,
+ speed = options.scrollSpeed,
+ winScroller = getWindowScrollingElement();
+
+ let scrollThisInstance = false,
+ scrollCustomFn;
+
+ // New scroll root, set scrollEl
+ if (scrollRootEl !== rootEl) {
+ scrollRootEl = rootEl;
+
+ clearAutoScrolls();
+
+ scrollEl = options.scroll;
+ scrollCustomFn = options.scrollFn;
+
+ if (scrollEl === true) {
+ scrollEl = getParentAutoScrollElement(rootEl, true);
+ }
+ }
+
+
+ let layersOut = 0;
+ let currentParent = scrollEl;
+ do {
+ let el = currentParent,
+ rect = getRect(el),
+
+ top = rect.top,
+ bottom = rect.bottom,
+ left = rect.left,
+ right = rect.right,
+
+ width = rect.width,
+ height = rect.height,
+
+ canScrollX,
+ canScrollY,
+
+ scrollWidth = el.scrollWidth,
+ scrollHeight = el.scrollHeight,
+
+ elCSS = css(el),
+
+ scrollPosX = el.scrollLeft,
+ scrollPosY = el.scrollTop;
+
+
+ if (el === winScroller) {
+ canScrollX = width < scrollWidth && (elCSS.overflowX === 'auto' || elCSS.overflowX === 'scroll' || elCSS.overflowX === 'visible');
+ canScrollY = height < scrollHeight && (elCSS.overflowY === 'auto' || elCSS.overflowY === 'scroll' || elCSS.overflowY === 'visible');
+ } else {
+ canScrollX = width < scrollWidth && (elCSS.overflowX === 'auto' || elCSS.overflowX === 'scroll');
+ canScrollY = height < scrollHeight && (elCSS.overflowY === 'auto' || elCSS.overflowY === 'scroll');
+ }
+
+ let vx = canScrollX && (Math.abs(right - x) <= sens && (scrollPosX + width) < scrollWidth) - (Math.abs(left - x) <= sens && !!scrollPosX);
+ let vy = canScrollY && (Math.abs(bottom - y) <= sens && (scrollPosY + height) < scrollHeight) - (Math.abs(top - y) <= sens && !!scrollPosY);
+
+
+ if (!autoScrolls[layersOut]) {
+ for (let i = 0; i <= layersOut; i++) {
+ if (!autoScrolls[i]) {
+ autoScrolls[i] = {};
+ }
+ }
+ }
+
+ if (autoScrolls[layersOut].vx != vx || autoScrolls[layersOut].vy != vy || autoScrolls[layersOut].el !== el) {
+ autoScrolls[layersOut].el = el;
+ autoScrolls[layersOut].vx = vx;
+ autoScrolls[layersOut].vy = vy;
+
+ clearInterval(autoScrolls[layersOut].pid);
+
+ if (vx != 0 || vy != 0) {
+ scrollThisInstance = true;
+ /* jshint loopfunc:true */
+ autoScrolls[layersOut].pid = setInterval((function () {
+ // emulate drag over during autoscroll (fallback), emulating native DnD behaviour
+ if (isFallback && this.layer === 0) {
+ Sortable.active._onTouchMove(touchEvt); // To move ghost if it is positioned absolutely
+ }
+ let scrollOffsetY = autoScrolls[this.layer].vy ? autoScrolls[this.layer].vy * speed : 0;
+ let scrollOffsetX = autoScrolls[this.layer].vx ? autoScrolls[this.layer].vx * speed : 0;
+
+ if (typeof(scrollCustomFn) === 'function') {
+ if (scrollCustomFn.call(Sortable.dragged.parentNode[expando], scrollOffsetX, scrollOffsetY, evt, touchEvt, autoScrolls[this.layer].el) !== 'continue') {
+ return;
+ }
+ }
+
+ scrollBy(autoScrolls[this.layer].el, scrollOffsetX, scrollOffsetY);
+ }).bind({layer: layersOut}), 24);
+ }
+ }
+ layersOut++;
+ } while (options.bubbleScroll && currentParent !== winScroller && (currentParent = getParentAutoScrollElement(currentParent, false)));
+ scrolling = scrollThisInstance; // in case another function catches scrolling as false in between when it is not
+}, 30);
+
+export default AutoScrollPlugin;
diff --git a/library/Sortable/plugins/AutoScroll/README.md b/library/Sortable/plugins/AutoScroll/README.md
new file mode 100644
index 000000000..dd77aede6
--- /dev/null
+++ b/library/Sortable/plugins/AutoScroll/README.md
@@ -0,0 +1,110 @@
+## AutoScroll
+This plugin allows for the page to automatically scroll during dragging near a scrollable element's edge on mobile devices and IE9 (or whenever fallback is enabled), and also enhances most browser's native drag-and-drop autoscrolling.
+Demo:
+ - `window`: https://jsbin.com/dosilir/edit?js,output
+ - `overflow: hidden`: https://jsbin.com/xecihez/edit?html,js,output
+
+**This plugin is a default plugin, and is included in the default UMD and ESM builds of Sortable**
+
+
+---
+
+
+### Mounting
+```js
+import { Sortable, AutoScroll } from 'sortablejs';
+
+Sortable.mount(new AutoScroll());
+```
+
+
+---
+
+
+### Options
+
+```js
+new Sortable(el, {
+ scroll: true, // Enable the plugin. Can be HTMLElement.
+ forceAutoscrollFallback: false, // force autoscroll plugin to enable even when native browser autoscroll is available
+ scrollFn: function(offsetX, offsetY, originalEvent, touchEvt, hoverTargetEl) { ... }, // 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, speed of the scrolling
+ bubbleScroll: true // apply autoscroll to all parent elements, allowing for easier movement
+});
+```
+
+
+---
+
+
+#### `scroll` option
+Enables the plugin. Defaults to `true`. May also be set to an HTMLElement which will be where autoscrolling is rooted.
+
+**Note: Just because this plugin is enabled does not mean that it will always be used for autoscrolling. Some browsers have native drag and drop autoscroll, in which case this autoscroll plugin won't be invoked. If you wish to have this always be invoked for autoscrolling, set the option `forceAutoScrollFallback` to `true`.**
+
+Demo:
+ - `window`: https://jsbin.com/dosilir/edit?js,output
+ - `overflow: hidden`: https://jsbin.com/xecihez/edit?html,js,output
+
+
+---
+
+
+#### `forceAutoScrollFallback` option
+Enables sortable's autoscroll even when the browser can handle it (with native drag and drop). Defaults to `false`. This will not disable the native autoscrolling. Note that setting `forceFallback: true` in the sortable options will also enable this.
+
+
+---
+
+
+#### `scrollFn` option
+Useful when you have custom scrollbar with dedicated scroll function.
+Defines a function that will be used for autoscrolling. Sortable uses el.scrollTop/el.scrollLeft by default. Set this option if you wish to handle it differently.
+This function should return `'continue'` if it wishes to allow Sortable's native autoscrolling, otherwise Sortable will not scroll anything if this option is set.
+
+**Note that this option will only work if Sortable's autoscroll function is invoked.**
+
+It is invoked if any of the following are true:
+ - The `forceFallback: true` option is set
+ - It is a mobile device
+ - The browser is either Safari, Internet Explorer, or Edge
+
+
+---
+
+
+#### `scrollSensitivity` option
+Defines how near the mouse must be to an edge to start scrolling.
+
+**Note that this option will only work if Sortable's autoscroll function is invoked.**
+
+It is invoked if any of the following are true:
+ - The `forceFallback: true` option is set
+ - It is a mobile device
+ - The browser is either Safari, Internet Explorer, or Edge
+
+
+---
+
+
+#### `scrollSpeed` option
+The speed at which the window should scroll once the mouse pointer gets within the `scrollSensitivity` distance.
+
+**Note that this option will only work if Sortable's autoscroll function is invoked.**
+
+It is invoked if any of the following are true:
+ - The `forceFallback: true` option is set
+ - It is a mobile device
+ - The browser is either Safari, Internet Explorer, or Edge
+
+---
+
+
+#### `bubbleScroll` option
+If set to `true`, the normal `autoscroll` function will also be applied to all parent elements of the element the user is dragging over.
+
+Demo: https://jsbin.com/kesewor/edit?html,js,output
+
+
+---
diff --git a/library/Sortable/plugins/AutoScroll/index.js b/library/Sortable/plugins/AutoScroll/index.js
new file mode 100644
index 000000000..cc79f7e24
--- /dev/null
+++ b/library/Sortable/plugins/AutoScroll/index.js
@@ -0,0 +1 @@
+export { default } from './AutoScroll.js';
diff --git a/library/Sortable/plugins/MultiDrag/MultiDrag.js b/library/Sortable/plugins/MultiDrag/MultiDrag.js
new file mode 100644
index 000000000..4162037ce
--- /dev/null
+++ b/library/Sortable/plugins/MultiDrag/MultiDrag.js
@@ -0,0 +1,618 @@
+import {
+ toggleClass,
+ getRect,
+ index,
+ closest,
+ on,
+ off,
+ clone,
+ css,
+ setRect,
+ unsetRect,
+ matrix,
+ expando
+} from '../../src/utils.js';
+
+import dispatchEvent from '../../src/EventDispatcher.js';
+
+let multiDragElements = [],
+ multiDragClones = [],
+ lastMultiDragSelect, // for selection with modifier key down (SHIFT)
+ multiDragSortable,
+ initialFolding = false, // Initial multi-drag fold when drag started
+ folding = false, // Folding any other time
+ dragStarted = false,
+ dragEl,
+ clonesFromRect,
+ clonesHidden;
+
+function MultiDragPlugin() {
+ function MultiDrag(sortable) {
+ // Bind all private methods
+ for (let fn in this) {
+ if (fn.charAt(0) === '_' && typeof this[fn] === 'function') {
+ this[fn] = this[fn].bind(this);
+ }
+ }
+
+ if (sortable.options.supportPointer) {
+ on(document, 'pointerup', this._deselectMultiDrag);
+ } else {
+ on(document, 'mouseup', this._deselectMultiDrag);
+ on(document, 'touchend', this._deselectMultiDrag);
+ }
+
+ on(document, 'keydown', this._checkKeyDown);
+ on(document, 'keyup', this._checkKeyUp);
+
+ this.defaults = {
+ selectedClass: 'sortable-selected',
+ multiDragKey: null,
+ setData(dataTransfer, dragEl) {
+ let data = '';
+ if (multiDragElements.length && multiDragSortable === sortable) {
+ multiDragElements.forEach((multiDragElement, i) => {
+ data += (!i ? '' : ', ') + multiDragElement.textContent;
+ });
+ } else {
+ data = dragEl.textContent;
+ }
+ dataTransfer.setData('Text', data);
+ }
+ };
+ }
+
+ MultiDrag.prototype = {
+ multiDragKeyDown: false,
+ isMultiDrag: false,
+
+
+ delayStartGlobal({ dragEl: dragged }) {
+ dragEl = dragged;
+ },
+
+ delayEnded() {
+ this.isMultiDrag = ~multiDragElements.indexOf(dragEl);
+ },
+
+ setupClone({ sortable, cancel }) {
+ if (!this.isMultiDrag) return;
+ for (let i = 0; i < multiDragElements.length; i++) {
+ multiDragClones.push(clone(multiDragElements[i]));
+
+ multiDragClones[i].sortableIndex = multiDragElements[i].sortableIndex;
+
+ multiDragClones[i].draggable = false;
+ multiDragClones[i].style['will-change'] = '';
+
+ toggleClass(multiDragClones[i], this.options.selectedClass, false);
+ multiDragElements[i] === dragEl && toggleClass(multiDragClones[i], this.options.chosenClass, false);
+ }
+
+ sortable._hideClone();
+ cancel();
+ },
+
+ clone({ sortable, rootEl, dispatchSortableEvent, cancel }) {
+ if (!this.isMultiDrag) return;
+ if (!this.options.removeCloneOnHide) {
+ if (multiDragElements.length && multiDragSortable === sortable) {
+ insertMultiDragClones(true, rootEl);
+ dispatchSortableEvent('clone');
+
+ cancel();
+ }
+ }
+ },
+
+ showClone({ cloneNowShown, rootEl, cancel }) {
+ if (!this.isMultiDrag) return;
+ insertMultiDragClones(false, rootEl);
+ multiDragClones.forEach(clone => {
+ css(clone, 'display', '');
+ });
+
+ cloneNowShown();
+ clonesHidden = false;
+ cancel();
+ },
+
+ hideClone({ sortable, cloneNowHidden, cancel }) {
+ if (!this.isMultiDrag) return;
+ multiDragClones.forEach(clone => {
+ css(clone, 'display', 'none');
+ if (this.options.removeCloneOnHide && clone.parentNode) {
+ clone.parentNode.removeChild(clone);
+ }
+ });
+
+ cloneNowHidden();
+ clonesHidden = true;
+ cancel();
+ },
+
+ dragStartGlobal({ sortable }) {
+ if (!this.isMultiDrag && multiDragSortable) {
+ multiDragSortable.multiDrag._deselectMultiDrag();
+ }
+
+ multiDragElements.forEach(multiDragElement => {
+ multiDragElement.sortableIndex = index(multiDragElement);
+ });
+
+ // Sort multi-drag elements
+ multiDragElements = multiDragElements.sort(function(a, b) {
+ return a.sortableIndex - b.sortableIndex;
+ });
+ dragStarted = true;
+ },
+
+ dragStarted({ sortable }) {
+ if (!this.isMultiDrag) return;
+ if (this.options.sort) {
+ // Capture rects,
+ // hide multi drag elements (by positioning them absolute),
+ // set multi drag elements rects to dragRect,
+ // show multi drag elements,
+ // animate to rects,
+ // unset rects & remove from DOM
+
+ sortable.captureAnimationState();
+
+ if (this.options.animation) {
+ multiDragElements.forEach(multiDragElement => {
+ if (multiDragElement === dragEl) return;
+ css(multiDragElement, 'position', 'absolute');
+ });
+
+ let dragRect = getRect(dragEl, false, true, true);
+
+ multiDragElements.forEach(multiDragElement => {
+ if (multiDragElement === dragEl) return;
+ setRect(multiDragElement, dragRect);
+ });
+
+ folding = true;
+ initialFolding = true;
+ }
+ }
+
+ sortable.animateAll(() => {
+ folding = false;
+ initialFolding = false;
+
+ if (this.options.animation) {
+ multiDragElements.forEach(multiDragElement => {
+ unsetRect(multiDragElement);
+ });
+ }
+
+ // Remove all auxiliary multidrag items from el, if sorting enabled
+ if (this.options.sort) {
+ removeMultiDragElements();
+ }
+ });
+ },
+
+ dragOver({ target, completed, cancel }) {
+ if (folding && ~multiDragElements.indexOf(target)) {
+ completed(false);
+ cancel();
+ }
+ },
+
+ revert({ fromSortable, rootEl, sortable, dragRect }) {
+ if (multiDragElements.length > 1) {
+ // Setup unfold animation
+ multiDragElements.forEach(multiDragElement => {
+ sortable.addAnimationState({
+ target: multiDragElement,
+ rect: folding ? getRect(multiDragElement) : dragRect
+ });
+
+ unsetRect(multiDragElement);
+
+ multiDragElement.fromRect = dragRect;
+
+ fromSortable.removeAnimationState(multiDragElement);
+ });
+ folding = false;
+ insertMultiDragElements(!this.options.removeCloneOnHide, rootEl);
+ }
+ },
+
+ dragOverCompleted({ sortable, isOwner, insertion, activeSortable, parentEl, putSortable }) {
+ let options = this.options;
+ if (insertion) {
+ // Clones must be hidden before folding animation to capture dragRectAbsolute properly
+ if (isOwner) {
+ activeSortable._hideClone();
+ }
+
+ initialFolding = false;
+ // If leaving sort:false root, or already folding - Fold to new location
+ if (options.animation && multiDragElements.length > 1 && (folding || !isOwner && !activeSortable.options.sort && !putSortable)) {
+ // Fold: Set all multi drag elements's rects to dragEl's rect when multi-drag elements are invisible
+ let dragRectAbsolute = getRect(dragEl, false, true, true);
+
+ multiDragElements.forEach(multiDragElement => {
+ if (multiDragElement === dragEl) return;
+ setRect(multiDragElement, dragRectAbsolute);
+
+ // Move element(s) to end of parentEl so that it does not interfere with multi-drag clones insertion if they are inserted
+ // while folding, and so that we can capture them again because old sortable will no longer be fromSortable
+ parentEl.appendChild(multiDragElement);
+ });
+
+ folding = true;
+ }
+
+ // Clones must be shown (and check to remove multi drags) after folding when interfering multiDragElements are moved out
+ if (!isOwner) {
+ // Only remove if not folding (folding will remove them anyways)
+ if (!folding) {
+ removeMultiDragElements();
+ }
+
+ if (multiDragElements.length > 1) {
+ let clonesHiddenBefore = clonesHidden;
+ activeSortable._showClone(sortable);
+
+ // Unfold animation for clones if showing from hidden
+ if (activeSortable.options.animation && !clonesHidden && clonesHiddenBefore) {
+ multiDragClones.forEach(clone => {
+ activeSortable.addAnimationState({
+ target: clone,
+ rect: clonesFromRect
+ });
+
+ clone.fromRect = clonesFromRect;
+ clone.thisAnimationDuration = null;
+ });
+ }
+ } else {
+ activeSortable._showClone(sortable);
+ }
+ }
+ }
+ },
+
+ dragOverAnimationCapture({ dragRect, isOwner, activeSortable }) {
+ multiDragElements.forEach(multiDragElement => {
+ multiDragElement.thisAnimationDuration = null;
+ });
+
+ if (activeSortable.options.animation && !isOwner && activeSortable.multiDrag.isMultiDrag) {
+ clonesFromRect = Object.assign({}, dragRect);
+ let dragMatrix = matrix(dragEl, true);
+ clonesFromRect.top -= dragMatrix.f;
+ clonesFromRect.left -= dragMatrix.e;
+ }
+ },
+
+ dragOverAnimationComplete() {
+ if (folding) {
+ folding = false;
+ removeMultiDragElements();
+ }
+ },
+
+ drop({ originalEvent: evt, rootEl, parentEl, sortable, dispatchSortableEvent, oldIndex, putSortable }) {
+ let toSortable = (putSortable || this.sortable);
+
+ if (!evt) return;
+
+ let options = this.options,
+ children = parentEl.children;
+
+ // Multi-drag selection
+ if (!dragStarted) {
+ if (options.multiDragKey && !this.multiDragKeyDown) {
+ this._deselectMultiDrag();
+ }
+ toggleClass(dragEl, options.selectedClass, !~multiDragElements.indexOf(dragEl));
+
+ if (!~multiDragElements.indexOf(dragEl)) {
+ multiDragElements.push(dragEl);
+ dispatchEvent({
+ sortable,
+ rootEl,
+ name: 'select',
+ targetEl: dragEl,
+ originalEvt: evt
+ });
+
+ // Modifier activated, select from last to dragEl
+ if (evt.shiftKey && lastMultiDragSelect && sortable.el.contains(lastMultiDragSelect)) {
+ let lastIndex = index(lastMultiDragSelect),
+ currentIndex = index(dragEl);
+
+ if (~lastIndex && ~currentIndex && lastIndex !== currentIndex) {
+ // Must include lastMultiDragSelect (select it), in case modified selection from no selection
+ // (but previous selection existed)
+ let n, i;
+ if (currentIndex > lastIndex) {
+ i = lastIndex;
+ n = currentIndex;
+ } else {
+ i = currentIndex;
+ n = lastIndex + 1;
+ }
+
+ for (; i < n; i++) {
+ if (~multiDragElements.indexOf(children[i])) continue;
+ toggleClass(children[i], options.selectedClass, true);
+ multiDragElements.push(children[i]);
+
+ dispatchEvent({
+ sortable,
+ rootEl,
+ name: 'select',
+ targetEl: children[i],
+ originalEvt: evt
+ });
+ }
+ }
+ } else {
+ lastMultiDragSelect = dragEl;
+ }
+
+ multiDragSortable = toSortable;
+ } else {
+ multiDragElements.splice(multiDragElements.indexOf(dragEl), 1);
+ lastMultiDragSelect = null;
+ dispatchEvent({
+ sortable,
+ rootEl,
+ name: 'deselect',
+ targetEl: dragEl,
+ originalEvt: evt
+ });
+ }
+ }
+
+ // Multi-drag drop
+ if (dragStarted && this.isMultiDrag) {
+ folding = false;
+ // Do not "unfold" after around dragEl if reverted
+ if ((parentEl[expando].options.sort || parentEl !== rootEl) && multiDragElements.length > 1) {
+ let dragRect = getRect(dragEl),
+ multiDragIndex = index(dragEl, ':not(.' + this.options.selectedClass + ')');
+
+ if (!initialFolding && options.animation) dragEl.thisAnimationDuration = null;
+
+ toSortable.captureAnimationState();
+
+ if (!initialFolding) {
+ if (options.animation) {
+ dragEl.fromRect = dragRect;
+ multiDragElements.forEach(multiDragElement => {
+ multiDragElement.thisAnimationDuration = null;
+ if (multiDragElement !== dragEl) {
+ let rect = folding ? getRect(multiDragElement) : dragRect;
+ multiDragElement.fromRect = rect;
+
+ // Prepare unfold animation
+ toSortable.addAnimationState({
+ target: multiDragElement,
+ rect: rect
+ });
+ }
+ });
+ }
+
+ // Multi drag elements are not necessarily removed from the DOM on drop, so to reinsert
+ // properly they must all be removed
+ removeMultiDragElements();
+
+ multiDragElements.forEach(multiDragElement => {
+ if (children[multiDragIndex]) {
+ parentEl.insertBefore(multiDragElement, children[multiDragIndex]);
+ } else {
+ parentEl.appendChild(multiDragElement);
+ }
+ multiDragIndex++;
+ });
+
+ // If initial folding is done, the elements may have changed position because they are now
+ // unfolding around dragEl, even though dragEl may not have his index changed, so update event
+ // must be fired here as Sortable will not.
+ if (oldIndex === index(dragEl)) {
+ let update = false;
+ multiDragElements.forEach(multiDragElement => {
+ if (multiDragElement.sortableIndex !== index(multiDragElement)) {
+ update = true;
+ return;
+ }
+ });
+
+ if (update) {
+ dispatchSortableEvent('update');
+ }
+ }
+ }
+
+ // Must be done after capturing individual rects (scroll bar)
+ multiDragElements.forEach(multiDragElement => {
+ unsetRect(multiDragElement);
+ });
+
+ toSortable.animateAll();
+ }
+
+ multiDragSortable = toSortable;
+ }
+
+ // Remove clones if necessary
+ if (rootEl === parentEl || (putSortable && putSortable.lastPutMode !== 'clone')) {
+ multiDragClones.forEach(clone => {
+ clone.parentNode && clone.parentNode.removeChild(clone);
+ });
+ }
+ },
+
+ nullingGlobal() {
+ this.isMultiDrag =
+ dragStarted = false;
+ multiDragClones.length = 0;
+ },
+
+ destroyGlobal() {
+ this._deselectMultiDrag();
+ off(document, 'pointerup', this._deselectMultiDrag);
+ off(document, 'mouseup', this._deselectMultiDrag);
+ off(document, 'touchend', this._deselectMultiDrag);
+
+ off(document, 'keydown', this._checkKeyDown);
+ off(document, 'keyup', this._checkKeyUp);
+ },
+
+ _deselectMultiDrag(evt) {
+ if (typeof dragStarted !== "undefined" && dragStarted) return;
+
+ // Only deselect if selection is in this sortable
+ if (multiDragSortable !== this.sortable) return;
+
+ // Only deselect if target is not item in this sortable
+ if (evt && closest(evt.target, this.options.draggable, this.sortable.el, false)) return;
+
+ // Only deselect if left click
+ if (evt && evt.button !== 0) return;
+
+ while (multiDragElements.length) {
+ let el = multiDragElements[0];
+ toggleClass(el, this.options.selectedClass, false);
+ multiDragElements.shift();
+ dispatchEvent({
+ sortable: this.sortable,
+ rootEl: this.sortable.el,
+ name: 'deselect',
+ targetEl: el,
+ originalEvt: evt
+ });
+ }
+ },
+
+ _checkKeyDown(evt) {
+ if (evt.key === this.options.multiDragKey) {
+ this.multiDragKeyDown = true;
+ }
+ },
+
+ _checkKeyUp(evt) {
+ if (evt.key === this.options.multiDragKey) {
+ this.multiDragKeyDown = false;
+ }
+ }
+ };
+
+ return Object.assign(MultiDrag, {
+ // Static methods & properties
+ pluginName: 'multiDrag',
+ utils: {
+ /**
+ * Selects the provided multi-drag item
+ * @param {HTMLElement} el The element to be selected
+ */
+ select(el) {
+ let sortable = el.parentNode[expando];
+ if (!sortable || !sortable.options.multiDrag || ~multiDragElements.indexOf(el)) return;
+ if (multiDragSortable && multiDragSortable !== sortable) {
+ multiDragSortable.multiDrag._deselectMultiDrag();
+ multiDragSortable = sortable;
+ }
+ toggleClass(el, sortable.options.selectedClass, true);
+ multiDragElements.push(el);
+ },
+ /**
+ * Deselects the provided multi-drag item
+ * @param {HTMLElement} el The element to be deselected
+ */
+ deselect(el) {
+ let sortable = el.parentNode[expando],
+ index = multiDragElements.indexOf(el);
+ if (!sortable || !sortable.options.multiDrag || !~index) return;
+ toggleClass(el, sortable.options.selectedClass, false);
+ multiDragElements.splice(index, 1);
+ }
+ },
+ eventProperties() {
+ const oldIndicies = [],
+ newIndicies = [];
+
+ multiDragElements.forEach(multiDragElement => {
+ oldIndicies.push({
+ multiDragElement,
+ index: multiDragElement.sortableIndex
+ });
+
+ // multiDragElements will already be sorted if folding
+ let newIndex;
+ if (folding && multiDragElement !== dragEl) {
+ newIndex = -1;
+ } else if (folding) {
+ newIndex = index(multiDragElement, ':not(.' + this.options.selectedClass + ')');
+ } else {
+ newIndex = index(multiDragElement);
+ }
+ newIndicies.push({
+ multiDragElement,
+ index: newIndex
+ });
+ });
+ return {
+ items: [...multiDragElements],
+ clones: [...multiDragClones],
+ oldIndicies,
+ newIndicies
+ };
+ },
+ optionListeners: {
+ multiDragKey(key) {
+ key = key.toLowerCase();
+ if (key === 'ctrl') {
+ key = 'Control';
+ } else if (key.length > 1) {
+ key = key.charAt(0).toUpperCase() + key.substr(1);
+ }
+ return key;
+ }
+ }
+ });
+}
+
+function insertMultiDragElements(clonesInserted, rootEl) {
+ multiDragElements.forEach((multiDragElement, i) => {
+ let target = rootEl.children[multiDragElement.sortableIndex + (clonesInserted ? Number(i) : 0)];
+ if (target) {
+ rootEl.insertBefore(multiDragElement, target);
+ } else {
+ rootEl.appendChild(multiDragElement);
+ }
+ });
+}
+
+/**
+ * Insert multi-drag clones
+ * @param {[Boolean]} elementsInserted Whether the multi-drag elements are inserted
+ * @param {HTMLElement} rootEl
+ */
+function insertMultiDragClones(elementsInserted, rootEl) {
+ multiDragClones.forEach((clone, i) => {
+ let target = rootEl.children[clone.sortableIndex + (elementsInserted ? Number(i) : 0)];
+ if (target) {
+ rootEl.insertBefore(clone, target);
+ } else {
+ rootEl.appendChild(clone);
+ }
+ });
+}
+
+function removeMultiDragElements() {
+ multiDragElements.forEach(multiDragElement => {
+ if (multiDragElement === dragEl) return;
+ multiDragElement.parentNode && multiDragElement.parentNode.removeChild(multiDragElement);
+ });
+}
+
+export default MultiDragPlugin;
diff --git a/library/Sortable/plugins/MultiDrag/README.md b/library/Sortable/plugins/MultiDrag/README.md
new file mode 100644
index 000000000..a7cb4d596
--- /dev/null
+++ b/library/Sortable/plugins/MultiDrag/README.md
@@ -0,0 +1,96 @@
+## MultiDrag Plugin
+This plugin allows users to select multiple items within a sortable at once, and drag them as one item.
+Once placed, the items will unfold into their original order, but all beside each other at the new position.
+[Read More](https://github.com/SortableJS/Sortable/wiki/Dragging-Multiple-Items-in-Sortable)
+
+Demo: https://jsbin.com/wopavom/edit?js,output
+
+
+---
+
+
+### Mounting
+```js
+import { Sortable, MultiDrag } from 'sortablejs';
+
+Sortable.mount(new MultiDrag());
+```
+
+
+---
+
+
+### Options
+
+```js
+new Sortable(el, {
+ multiDrag: true, // Enable the plugin
+ selectedClass: "sortable-selected", // Class name for selected item
+ multiDragKey: null, // Key that must be down for items to be selected
+
+ // Called when an item is selected
+ onSelect: function(/**Event*/evt) {
+ evt.item // The selected item
+ },
+
+ // Called when an item is deselected
+ onDeselect: function(/**Event*/evt) {
+ evt.item // The deselected item
+ }
+});
+```
+
+
+---
+
+
+#### `multiDragKey` option
+The key that must be down for multiple items to be selected. The default is `null`, meaning no key must be down.
+For special keys, such as the <kbd>CTRL</kbd> key, simply specify the option as `'CTRL'` (casing does not matter).
+
+
+---
+
+
+#### `selectedClass` option
+Class name for the selected item(s) if multiDrag is enabled. Defaults to `sortable-selected`.
+
+```css
+.selected {
+ background-color: #f9c7c8;
+ border: solid red 1px;
+}
+```
+
+```js
+Sortable.create(list, {
+ multiDrag: true,
+ selectedClass: "selected"
+});
+```
+
+
+---
+
+
+### Event Properties
+ - items:`HTMLElement[]` — Array of selected items, or empty
+ - clones:`HTMLElement[]` — Array of clones, or empty
+ - oldIndicies:`Index[]` — Array containing information on the old indicies of the selected elements.
+ - newIndicies:`Index[]` — Array containing information on the new indicies of the selected elements.
+
+#### Index Object
+ - element:`HTMLElement` — The element whose index is being given
+ - index:`Number` — The index of the element
+
+#### Note on `newIndicies`
+For any event that is fired during sorting, the index of any selected element that is not the main dragged element is given as `-1`.
+This is because it has either been removed from the DOM, or because it is in a folding animation (folding to the dragged element) and will be removed after this animation is complete.
+
+
+---
+
+
+### Sortable.utils
+* select(el:`HTMLElement`) — select the given multi-drag item
+* deselect(el:`HTMLElement`) — deselect the given multi-drag item
diff --git a/library/Sortable/plugins/MultiDrag/index.js b/library/Sortable/plugins/MultiDrag/index.js
new file mode 100644
index 000000000..2507117e0
--- /dev/null
+++ b/library/Sortable/plugins/MultiDrag/index.js
@@ -0,0 +1 @@
+export { default } from './MultiDrag.js';
diff --git a/library/Sortable/plugins/OnSpill/OnSpill.js b/library/Sortable/plugins/OnSpill/OnSpill.js
new file mode 100644
index 000000000..e8c6439d9
--- /dev/null
+++ b/library/Sortable/plugins/OnSpill/OnSpill.js
@@ -0,0 +1,79 @@
+import { getChild } from '../../src/utils.js';
+
+
+const drop = function({
+ originalEvent,
+ putSortable,
+ dragEl,
+ activeSortable,
+ dispatchSortableEvent,
+ hideGhostForTarget,
+ unhideGhostForTarget
+}) {
+ if (!originalEvent) return;
+ let toSortable = putSortable || activeSortable;
+ hideGhostForTarget();
+ let touch = originalEvent.changedTouches && originalEvent.changedTouches.length ? originalEvent.changedTouches[0] : originalEvent;
+ let target = document.elementFromPoint(touch.clientX, touch.clientY);
+ unhideGhostForTarget();
+ if (toSortable && !toSortable.el.contains(target)) {
+ dispatchSortableEvent('spill');
+ this.onSpill({ dragEl, putSortable });
+ }
+};
+
+function Revert() {}
+
+Revert.prototype = {
+ startIndex: null,
+ dragStart({ oldDraggableIndex }) {
+ this.startIndex = oldDraggableIndex;
+ },
+ onSpill({ dragEl, putSortable }) {
+ this.sortable.captureAnimationState();
+ if (putSortable) {
+ putSortable.captureAnimationState();
+ }
+ let nextSibling = getChild(this.sortable.el, this.startIndex, this.options);
+
+ if (nextSibling) {
+ this.sortable.el.insertBefore(dragEl, nextSibling);
+ } else {
+ this.sortable.el.appendChild(dragEl);
+ }
+ this.sortable.animateAll();
+ if (putSortable) {
+ putSortable.animateAll();
+ }
+ },
+ drop
+};
+
+Object.assign(Revert, {
+ pluginName: 'revertOnSpill'
+});
+
+
+function Remove() {}
+
+Remove.prototype = {
+ onSpill({ dragEl, putSortable }) {
+ const parentSortable = putSortable || this.sortable;
+ parentSortable.captureAnimationState();
+ dragEl.parentNode && dragEl.parentNode.removeChild(dragEl);
+ parentSortable.animateAll();
+ },
+ drop
+};
+
+Object.assign(Remove, {
+ pluginName: 'removeOnSpill'
+});
+
+
+export default [Remove, Revert];
+
+export {
+ Remove as RemoveOnSpill,
+ Revert as RevertOnSpill
+};
diff --git a/library/Sortable/plugins/OnSpill/README.md b/library/Sortable/plugins/OnSpill/README.md
new file mode 100644
index 000000000..816fd19cc
--- /dev/null
+++ b/library/Sortable/plugins/OnSpill/README.md
@@ -0,0 +1,60 @@
+# OnSpill Plugins
+This file contains two seperate plugins, RemoveOnSpill and RevertOnSpill. They can be imported individually, or the default export (an array of both plugins) can be passed to `Sortable.mount` as well.
+
+**These plugins are default plugins, and are included in the default UMD and ESM builds of Sortable**
+
+
+---
+
+
+### Mounting
+```js
+import { Sortable, OnSpill } from 'sortablejs/modular/sortable.core.esm';
+
+Sortable.mount(OnSpill);
+```
+
+
+---
+
+
+## RevertOnSpill Plugin
+This plugin, when enabled, will cause the dragged item to be reverted to it's original position if it is spilled (ie. it is dropped outside of a valid Sortable drop target)
+
+
+
+
+### Options
+
+```js
+new Sortable(el, {
+ revertOnSpill: true, // Enable plugin
+ // Called when item is spilled
+ onSpill: function(/**Event*/evt) {
+ evt.item // The spilled item
+ }
+});
+```
+
+
+---
+
+
+## RemoveOnSpill Plugin
+This plugin, when enabled, will cause the dragged item to be removed from the DOM if it is spilled (ie. it is dropped outside of a valid Sortable drop target)
+
+
+---
+
+
+### Options
+
+```js
+new Sortable(el, {
+ removeOnSpill: true, // Enable plugin
+ // Called when item is spilled
+ onSpill: function(/**Event*/evt) {
+ evt.item // The spilled item
+ }
+});
+```
diff --git a/library/Sortable/plugins/OnSpill/index.js b/library/Sortable/plugins/OnSpill/index.js
new file mode 100644
index 000000000..4023b0f60
--- /dev/null
+++ b/library/Sortable/plugins/OnSpill/index.js
@@ -0,0 +1 @@
+export { default, RemoveOnSpill, RevertOnSpill } from './OnSpill.js';
diff --git a/library/Sortable/plugins/README.md b/library/Sortable/plugins/README.md
new file mode 100644
index 000000000..1dbef58d0
--- /dev/null
+++ b/library/Sortable/plugins/README.md
@@ -0,0 +1,178 @@
+# Creating Sortable Plugins
+Sortable plugins are plugins that can be directly mounted to the Sortable class. They are a powerful way of modifying the default behaviour of Sortable beyond what simply using events alone allows. To mount your plugin to Sortable, it must pass a constructor function to the `Sortable.mount` function. This constructor function will be called (with the `new` keyword in front of it) whenever a Sortable instance with your plugin enabled is initialized. The constructor function will be called with the parameters `sortable` and `el`, which is the HTMLElement that the Sortable is being initialized on. This means that there will be a new instance of your plugin each time it is enabled in a Sortable.
+
+
+## Constructor Parameters
+
+`sortable: Sortable` — The sortable that the plugin is being initialized on
+
+`el: HTMLElement` — The element that the sortable is being initialized on
+
+`options: Object` — The options object that the user has passed into Sortable (not merged with defaults yet)
+
+
+## Static Properties
+The constructor function passed to `Sortable.mount` may contain several static properties and methods. The following static properties may be defined:
+
+`pluginName: String` (Required)
+The name of the option that the user will use in their sortable's options to enable the plugin. Should start with a lower case and be camel-cased. For example: `'multiDrag'`. This is also the property name that the plugin's instance will be under in a sortable instance (ex. `sortableInstance.multiDrag`).
+
+`utils: Object`
+Object containing functions that will be added to the `Sortable.utils` static object on the Sortable class.
+
+`eventOptions(eventName: String): Function`
+A function that is called whenever Sortable fires an event. This function should return an object to be combined with the event object that Sortable will emit. The function will be called in the context of the instance of the plugin on the Sortable that is firing the event (ie. the `this` keyword will be the plugin instance).
+
+`initializeByDefault: Boolean`
+Determines whether or not the plugin will always be initialized on every new Sortable instance. If this option is enabled, it does not mean that by default the plugin will be enabled on the Sortable - this must still be done in the options via the plugin's `pluginName`, or it can be enabled by default if your plugin specifies it's pluginName as a default option that is truthy. Since the plugin will already be initialized on every Sortable instance, it can also be enabled dynamically via `sortableInstance.option('pluginName', true)`.
+It is a good idea to have this option set to `false` if the plugin modifies the behaviour of Sortable in such a way that enabling or disabling the plugin dynamically could cause it to break. Likewise, this option should be disabled if the plugin should only be instantiated on Sortables in which that plugin is enabled.
+This option defaults to `true`.
+
+`optionListeners: Object`
+An object that may contain event listeners that are fired when a specific option is updated.
+These listeners are useful because the user's provided options are not necessarily unchanging once the plugin is initialized, and could be changed dynamically via the `option()` method.
+The listener will be fired in the context of the instance of the plugin that it is being changed in (ie. the `this` keyword will be the instance of your plugin).
+The name of the method should match the name of the option it listens for. The new value of the option will be passed in as an argument, and any returned value will be what the option is stored as. If no value is returned, the option will be stored as the value the user provided.
+
+Example:
+
+```js
+Plugin.name = 'generateTitle';
+Plugin.optionListeners = {
+ // Listen for option 'generateTitle'
+ generateTitle: function(title) {
+ // Store the option in all caps
+ return title.toUpperCase();
+
+ // OR save it to this instance of your plugin as a private field.
+ // This way it can be accessed in events, but will not modify the user's options.
+ this.titleAllCaps = title.toUpperCase();
+ }
+};
+
+```
+
+## Plugin Options
+Plugins may have custom default options or may override the defaults of other options. In order to do this, there must be a `defaults` object on the initialized plugin. This can be set in the plugin's prototype, or during the initialization of the plugin (when the `el` is available). For example:
+
+```js
+function myPlugin(sortable, el, options) {
+ this.defaults = {
+ color: el.style.backgroundColor
+ };
+}
+
+Sortable.mount(myPlugin);
+```
+
+
+## Plugin Events
+
+### Context
+The events will be fired in the context of their own parent object (ie. context is not changed), however the plugin instance's Sortable instance is available under `this.sortable`. Likewise, the options are available under `this.options`.
+
+### Event List
+The following table contains details on the events that a plugin may handle in the prototype of the plugin's constructor function.
+
+| Event Name | Description | Cancelable? | Cancel Behaviour | Event Type | Custom Event Object Properties |
+|---------------------------|------------------------------------------------------------------------------------------------------------------|-------------|----------------------------------------------------|------------|-------------------------------------------------------------------------|
+| filter | Fired when the element is filtered, and dragging is therefore canceled | No | - | Normal | None |
+| delayStart | Fired when the delay starts, even if there is no delay | Yes | Cancels sorting | Normal | None |
+| delayEnded | Fired when the delay ends, even if there is no delay | Yes | Cancels sorting | Normal | None |
+| setupClone | Fired when Sortable clones the dragged element | Yes | Cancels normal clone setup | Normal | None |
+| dragStart | Fired when the dragging is first started | Yes | Cancels sorting | Normal | None |
+| clone | Fired when the clone is inserted into the DOM (if `removeCloneOnHide: false`). Tick after dragStart. | Yes | Cancels normal clone insertion & hiding | Normal | None |
+| dragStarted | Fired tick after dragStart | No | - | Normal | None |
+| dragOver | Fired when the user drags over a sortable | Yes | Cancels normal dragover behaviour | DragOver | None |
+| dragOverValid | Fired when the user drags over a sortable that the dragged item can be inserted into | Yes | Cancels normal valid dragover behaviour | DragOver | None |
+| revert | Fired when the dragged item is reverted to it's original position when entering it's `sort:false` root | Yes | Cancels normal reverting, but is still completed() | DragOver | None |
+| dragOverCompleted | Fired when dragOver is completed (ie. bubbling is disabled). To check if inserted, use `inserted` even property. | No | - | DragOver | `insertion: Boolean` — Whether or not the dragged element was inserted |
+| dragOverAnimationCapture | Fired right before the animation state is captured in dragOver | No | - | DragOver | None |
+| dragOverAnimationComplete | Fired after the animation is completed after a dragOver insertion | No | - | DragOver | None |
+| drop | Fired on drop | Yes | Cancels normal drop behavior | Normal | None |
+| nulling | Fired when the plugin should preform cleanups, once all drop events have fired | No | - | Normal | None |
+| destroy | Fired when Sortable is destroyed | No | - | Normal | None |
+
+### Global Events
+Normally, an event will only be fired in a plugin if the plugin is enabled on the Sortable from which the event is being fired. However, it sometimes may be desirable for a plugin to listen in on an event from Sortables in which it is not enabled on. This is possible with global events. For an event to be global, simply add the suffix 'Global' to the event's name (casing matters) (eg. `dragStartGlobal`).
+Please note that your plugin must be initialized on any Sortable from which it expects to recieve events, and that includes global events. In other words, you will want to keep the `initializeByDefault` option as it's default `true` value if your plugin needs to recieve events from Sortables it is not enabled on.
+Please also note that if both normal and global event handlers are set, the global event handler will always be fired before the regular one.
+
+### Event Object
+An object with the following properties is passed as an argument to each plugin event when it is fired.
+
+#### Properties:
+
+`dragEl: HTMLElement` — The element being dragged
+
+`parentEl: HTMLElement` — The element that the dragged element is currently in
+
+`ghostEl: HTMLElement|undefined` — If using fallback, the element dragged under the cursor (undefined until after `dragStarted` plugin event)
+
+`rootEl: HTMLElement` — The element that the dragged element originated from
+
+`nextEl: HTMLElement` — The original next sibling of dragEl
+
+`cloneEl: HTMLElement|undefined` — The clone element (undefined until after `setupClone` plugin event)
+
+`cloneHidden: Boolean` — Whether or not the clone is hidden
+
+`dragStarted: Boolean` — Boolean indicating whether or not the dragStart event has fired
+
+`putSortable: Sortable|undefined` — The element that dragEl is dragged into from it's root, otherwise undefined
+
+`activeSortable: Sortable` — The active Sortable instance
+
+`originalEvent: Event` — The original HTML event corresponding to the Sortable event
+
+`oldIndex: Number` — The old index of dragEl
+
+`oldDraggableIndex: Number` — The old index of dragEl, only counting draggable elements
+
+`newIndex: Number` — The new index of dragEl
+
+`newDraggableIndex: Number` — The new index of dragEl, only counting draggable elements
+
+
+#### Methods:
+
+`cloneNowHidden()` — Function to be called if the plugin has hidden the clone
+
+`cloneNowShown()` — Function to be called if the plugin has shown the clone
+
+`hideGhostForTarget()` — Hides the fallback ghost element if CSS pointer-events are not available. Call this before using document.elementFromPoint at the mouse position.
+
+`unhideGhostForTarget()` — Unhides the ghost element. To be called after `hideGhostForTarget()`.
+
+`dispatchSortableEvent(eventName: String)` — Function that can be used to emit an event on the current sortable while sorting, with all usual event properties set (eg. indexes, rootEl, cloneEl, originalEvent, etc.).
+
+
+### DragOverEvent Object
+This event is passed to dragover events, and extends the normal event object.
+
+#### Properties:
+
+`isOwner: Boolean` — Whether or not the dragged over sortable currently contains the dragged element
+
+`axis: String` — Direction of the dragged over sortable, `'vertical'` or `'horizontal'`
+
+`revert: Boolean` — Whether or not the dragged element is being reverted to it's original position from another position
+
+`dragRect: DOMRect` — DOMRect of the dragged element
+
+`targetRect: DOMRect` — DOMRect of the target element
+
+`canSort: Boolean` — Whether or not sorting is enabled in the dragged over sortable
+
+`fromSortable: Sortable` — The sortable that the dragged element is coming from
+
+`target: HTMLElement` — The sortable item that is being dragged over
+
+
+#### Methods:
+
+`onMove(target: HTMLElement, after: Boolean): Boolean|Number` — Calls the `onMove` function the user specified in the options
+
+`changed()` — Fires the `onChange` event with event properties preconfigured
+
+`completed(insertion: Boolean)` — Should be called when dragover has "completed", meaning bubbling should be stopped. If `insertion` is `true`, Sortable will treat it as if the dragged element was inserted into the sortable, and hide/show clone, set ghost class, animate, etc.
diff --git a/library/Sortable/plugins/Swap/README.md b/library/Sortable/plugins/Swap/README.md
new file mode 100644
index 000000000..7c6e3994a
--- /dev/null
+++ b/library/Sortable/plugins/Swap/README.md
@@ -0,0 +1,55 @@
+## Swap Plugin
+This plugin modifies the behaviour of Sortable to allow for items to be swapped with eachother rather than sorted. Once dragging starts, the user can drag over other items and there will be no change in the elements. However, the item that the user drops on will be swapped with the originally dragged item.
+
+Demo: https://jsbin.com/yejehog/edit?html,js,output
+
+
+---
+
+
+### Mounting
+```js
+import { Sortable, Swap } from 'sortablejs/modular/sortable.core.esm';
+
+Sortable.mount(new Swap());
+```
+
+
+---
+
+
+### Options
+
+```js
+new Sortable(el, {
+ swap: true, // Enable swap mode
+ swapClass: "sortable-swap-highlight" // Class name for swap item (if swap mode is enabled)
+});
+```
+
+
+---
+
+
+#### `swapClass` option
+Class name for the item to be swapped with, if swap mode is enabled. Defaults to `sortable-swap-highlight`.
+
+```css
+.highlighted {
+ background-color: #9AB6F1;
+}
+```
+
+```js
+Sortable.create(list, {
+ swap: true,
+ swapClass: "highlighted"
+});
+```
+
+
+---
+
+
+### Event Properties
+ - swapItem:`HTMLElement|undefined` — The element that the dragged element was swapped with
diff --git a/library/Sortable/plugins/Swap/Swap.js b/library/Sortable/plugins/Swap/Swap.js
new file mode 100644
index 000000000..3f0feb7dc
--- /dev/null
+++ b/library/Sortable/plugins/Swap/Swap.js
@@ -0,0 +1,90 @@
+import {
+ toggleClass,
+ index
+} from '../../src/utils.js';
+
+let lastSwapEl;
+
+
+function SwapPlugin() {
+ function Swap() {
+ this.defaults = {
+ swapClass: 'sortable-swap-highlight'
+ };
+ }
+
+ Swap.prototype = {
+ dragStart({ dragEl }) {
+ lastSwapEl = dragEl;
+ },
+ dragOverValid({ completed, target, onMove, activeSortable, changed, cancel }) {
+ if (!activeSortable.options.swap) return;
+ let el = this.sortable.el,
+ options = this.options;
+ if (target && target !== el) {
+ let prevSwapEl = lastSwapEl;
+ if (onMove(target) !== false) {
+ toggleClass(target, options.swapClass, true);
+ lastSwapEl = target;
+ } else {
+ lastSwapEl = null;
+ }
+
+ if (prevSwapEl && prevSwapEl !== lastSwapEl) {
+ toggleClass(prevSwapEl, options.swapClass, false);
+ }
+ }
+ changed();
+
+ completed(true);
+ cancel();
+ },
+ drop({ activeSortable, putSortable, dragEl }) {
+ let toSortable = (putSortable || this.sortable);
+ let options = this.options;
+ lastSwapEl && toggleClass(lastSwapEl, options.swapClass, false);
+ if (lastSwapEl && (options.swap || putSortable && putSortable.options.swap)) {
+ if (dragEl !== lastSwapEl) {
+ toSortable.captureAnimationState();
+ if (toSortable !== activeSortable) activeSortable.captureAnimationState();
+ swapNodes(dragEl, lastSwapEl);
+
+ toSortable.animateAll();
+ if (toSortable !== activeSortable) activeSortable.animateAll();
+ }
+ }
+ },
+ nulling() {
+ lastSwapEl = null;
+ }
+ };
+
+ return Object.assign(Swap, {
+ pluginName: 'swap',
+ eventProperties() {
+ return {
+ swapItem: lastSwapEl
+ };
+ }
+ });
+}
+
+
+function swapNodes(n1, n2) {
+ let p1 = n1.parentNode,
+ p2 = n2.parentNode,
+ i1, i2;
+
+ if (!p1 || !p2 || p1.isEqualNode(n2) || p2.isEqualNode(n1)) return;
+
+ i1 = index(n1);
+ i2 = index(n2);
+
+ if (p1.isEqualNode(p2) && i1 < i2) {
+ i2++;
+ }
+ p1.insertBefore(n2, p1.children[i1]);
+ p2.insertBefore(n1, p2.children[i2]);
+}
+
+export default SwapPlugin;
diff --git a/library/Sortable/plugins/Swap/index.js b/library/Sortable/plugins/Swap/index.js
new file mode 100644
index 000000000..9799bc72c
--- /dev/null
+++ b/library/Sortable/plugins/Swap/index.js
@@ -0,0 +1 @@
+export { default } from './Swap.js';
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-12 08:40:11 +0000