-
-
Notifications
You must be signed in to change notification settings - Fork 458
/
Copy pathhtml5sortable.js
1214 lines (1191 loc) · 48.8 KB
/
html5sortable.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
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
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* HTML5Sortable package
* https://github.com/lukasoppermann/html5sortable
*
* Maintained by Lukas Oppermann <[email protected]>
*
* Released under the MIT license.
*/
var sortable = (function () {
'use strict';
/**
* Get or set data on element
* @param {HTMLElement} element
* @param {string} key
* @param {any} value
* @return {*}
*/
function addData(element, key, value) {
if (value === undefined) {
return element && element.h5s && element.h5s.data && element.h5s.data[key];
}
else {
element.h5s = element.h5s || {};
element.h5s.data = element.h5s.data || {};
element.h5s.data[key] = value;
}
}
/**
* Remove data from element
* @param {HTMLElement} element
*/
function removeData(element) {
if (element.h5s) {
delete element.h5s.data;
}
}
/* eslint-env browser */
/**
* Filter only wanted nodes
* @param {NodeList|HTMLCollection|Array} nodes
* @param {String} selector
* @returns {Array}
*/
var _filter = (function (nodes, selector) {
if (!(nodes instanceof NodeList || nodes instanceof HTMLCollection || nodes instanceof Array)) {
throw new Error('You must provide a nodeList/HTMLCollection/Array of elements to be filtered.');
}
if (typeof selector !== 'string') {
return Array.from(nodes);
}
return Array.from(nodes).filter(function (item) { return item.nodeType === 1 && item.matches(selector); });
});
/* eslint-env browser */
var stores = new Map();
/**
* Stores data & configurations per Sortable
* @param {Object} config
*/
var Store = /** @class */ (function () {
function Store() {
this._config = new Map(); // eslint-disable-line no-undef
this._placeholder = undefined; // eslint-disable-line no-undef
this._data = new Map(); // eslint-disable-line no-undef
}
Object.defineProperty(Store.prototype, "config", {
/**
* get the configuration map of a class instance
* @method config
* @return {object}
*/
get: function () {
// transform Map to object
var config = {};
this._config.forEach(function (value, key) {
config[key] = value;
});
// return object
return config;
},
/**
* set the configuration of a class instance
* @method config
* @param {object} config object of configurations
*/
set: function (config) {
if (typeof config !== 'object') {
throw new Error('You must provide a valid configuration object to the config setter.');
}
// combine config with default
var mergedConfig = Object.assign({}, config);
// add config to map
this._config = new Map(Object.entries(mergedConfig));
},
enumerable: true,
configurable: true
});
/**
* set individual configuration of a class instance
* @method setConfig
* @param key valid configuration key
* @param value any value
* @return void
*/
Store.prototype.setConfig = function (key, value) {
if (!this._config.has(key)) {
throw new Error("Trying to set invalid configuration item: " + key);
}
// set config
this._config.set(key, value);
};
/**
* get an individual configuration of a class instance
* @method getConfig
* @param key valid configuration key
* @return any configuration value
*/
Store.prototype.getConfig = function (key) {
if (!this._config.has(key)) {
throw new Error("Invalid configuration item requested: " + key);
}
return this._config.get(key);
};
Object.defineProperty(Store.prototype, "placeholder", {
/**
* get the placeholder for a class instance
* @method placeholder
* @return {HTMLElement|null}
*/
get: function () {
return this._placeholder;
},
/**
* set the placeholder for a class instance
* @method placeholder
* @param {HTMLElement} placeholder
* @return {void}
*/
set: function (placeholder) {
if (!(placeholder instanceof HTMLElement) && placeholder !== null) {
throw new Error('A placeholder must be an html element or null.');
}
this._placeholder = placeholder;
},
enumerable: true,
configurable: true
});
/**
* set an data entry
* @method setData
* @param {string} key
* @param {any} value
* @return {void}
*/
Store.prototype.setData = function (key, value) {
if (typeof key !== 'string') {
throw new Error("The key must be a string.");
}
this._data.set(key, value);
};
/**
* get an data entry
* @method getData
* @param {string} key an existing key
* @return {any}
*/
Store.prototype.getData = function (key) {
if (typeof key !== 'string') {
throw new Error("The key must be a string.");
}
return this._data.get(key);
};
/**
* delete an data entry
* @method deleteData
* @param {string} key an existing key
* @return {boolean}
*/
Store.prototype.deleteData = function (key) {
if (typeof key !== 'string') {
throw new Error("The key must be a string.");
}
return this._data.delete(key);
};
return Store;
}());
/**
* @param {HTMLElement} sortableElement
* @returns {Class: Store}
*/
var store = (function (sortableElement) {
// if sortableElement is wrong type
if (!(sortableElement instanceof HTMLElement)) {
throw new Error('Please provide a sortable to the store function.');
}
// create new instance if not avilable
if (!stores.has(sortableElement)) {
stores.set(sortableElement, new Store());
}
// return instance
return stores.get(sortableElement);
});
/**
* @param {Array|HTMLElement} element
* @param {Function} callback
* @param {string} event
*/
function addEventListener(element, eventName, callback) {
if (element instanceof Array) {
for (var i = 0; i < element.length; ++i) {
addEventListener(element[i], eventName, callback);
}
return;
}
element.addEventListener(eventName, callback);
store(element).setData("event" + eventName, callback);
}
/**
* @param {Array<HTMLElement>|HTMLElement} element
* @param {string} eventName
*/
function removeEventListener(element, eventName) {
if (element instanceof Array) {
for (var i = 0; i < element.length; ++i) {
removeEventListener(element[i], eventName);
}
return;
}
element.removeEventListener(eventName, store(element).getData("event" + eventName));
store(element).deleteData("event" + eventName);
}
/**
* @param {Array<HTMLElement>|HTMLElement} element
* @param {string} attribute
* @param {string} value
*/
function addAttribute(element, attribute, value) {
if (element instanceof Array) {
for (var i = 0; i < element.length; ++i) {
addAttribute(element[i], attribute, value);
}
return;
}
element.setAttribute(attribute, value);
}
/**
* @param {Array|HTMLElement} element
* @param {string} attribute
*/
function removeAttribute(element, attribute) {
if (element instanceof Array) {
for (var i = 0; i < element.length; ++i) {
removeAttribute(element[i], attribute);
}
return;
}
element.removeAttribute(attribute);
}
/**
* @param {HTMLElement} element
* @returns {Object}
*/
var _offset = (function (element) {
if (!element.parentElement || element.getClientRects().length === 0) {
throw new Error('target element must be part of the dom');
}
var rect = element.getClientRects()[0];
return {
left: rect.left + window.pageXOffset,
right: rect.right + window.pageXOffset,
top: rect.top + window.pageYOffset,
bottom: rect.bottom + window.pageYOffset
};
});
/**
* Creates and returns a new debounced version of the passed function which will postpone its execution until after wait milliseconds have elapsed
* @param {Function} func to debounce
* @param {number} time to wait before calling function with latest arguments, 0 - no debounce
* @returns {function} - debounced function
*/
var _debounce = (function (func, wait) {
if (wait === void 0) { wait = 0; }
var timeout;
return function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
clearTimeout(timeout);
timeout = setTimeout(function () {
func.apply(void 0, args);
}, wait);
};
});
/* eslint-env browser */
/**
* Get position of the element relatively to its sibling elements
* @param {HTMLElement} element
* @returns {number}
*/
var _index = (function (element, elementList) {
if (!(element instanceof HTMLElement) || !(elementList instanceof NodeList || elementList instanceof HTMLCollection || elementList instanceof Array)) {
throw new Error('You must provide an element and a list of elements.');
}
return Array.from(elementList).indexOf(element);
});
/* eslint-env browser */
/**
* Test whether element is in DOM
* @param {HTMLElement} element
* @returns {boolean}
*/
var isInDom = (function (element) {
if (!(element instanceof HTMLElement)) {
throw new Error('Element is not a node element.');
}
return element.parentNode !== null;
});
/* eslint-env browser */
/**
* Insert node before or after target
* @param {HTMLElement} referenceNode - reference element
* @param {HTMLElement} newElement - element to be inserted
* @param {String} position - insert before or after reference element
*/
var insertNode = function (referenceNode, newElement, position) {
if (!(referenceNode instanceof HTMLElement) || !(referenceNode.parentElement instanceof HTMLElement)) {
throw new Error('target and element must be a node');
}
referenceNode.parentElement.insertBefore(newElement, (position === 'before' ? referenceNode : referenceNode.nextElementSibling));
};
/**
* Insert before target
* @param {HTMLElement} target
* @param {HTMLElement} element
*/
var insertBefore = function (target, element) { return insertNode(target, element, 'before'); };
/**
* Insert after target
* @param {HTMLElement} target
* @param {HTMLElement} element
*/
var insertAfter = function (target, element) { return insertNode(target, element, 'after'); };
/* eslint-env browser */
/**
* Filter only wanted nodes
* @param {HTMLElement} sortableContainer
* @param {Function} customSerializer
* @returns {Array}
*/
var _serialize = (function (sortableContainer, customItemSerializer, customContainerSerializer) {
if (customItemSerializer === void 0) { customItemSerializer = function (serializedItem, sortableContainer) { return serializedItem; }; }
if (customContainerSerializer === void 0) { customContainerSerializer = function (serializedContainer) { return serializedContainer; }; }
// check for valid sortableContainer
if (!(sortableContainer instanceof HTMLElement) || !sortableContainer.isSortable === true) {
throw new Error('You need to provide a sortableContainer to be serialized.');
}
// check for valid serializers
if (typeof customItemSerializer !== 'function' || typeof customContainerSerializer !== 'function') {
throw new Error('You need to provide a valid serializer for items and the container.');
}
// get options
var options = addData(sortableContainer, 'opts');
var item = options.items;
// serialize container
var items = _filter(sortableContainer.children, item);
var serializedItems = items.map(function (item) {
return {
parent: sortableContainer,
node: item,
html: item.outerHTML,
index: _index(item, items)
};
});
// serialize container
var container = {
node: sortableContainer,
itemCount: serializedItems.length
};
return {
container: customContainerSerializer(container),
items: serializedItems.map(function (item) { return customItemSerializer(item, sortableContainer); })
};
});
/* eslint-env browser */
/**
* create a placeholder element
* @param {HTMLElement} sortableElement a single sortable
* @param {string|undefined} placeholder a string representing an html element
* @param {string} placeholderClasses a string representing the classes that should be added to the placeholder
*/
var _makePlaceholder = (function (sortableElement, placeholder, placeholderClass) {
var _a;
if (placeholderClass === void 0) { placeholderClass = 'sortable-placeholder'; }
if (!(sortableElement instanceof HTMLElement)) {
throw new Error('You must provide a valid element as a sortable.');
}
// if placeholder is not an element
if (!(placeholder instanceof HTMLElement) && placeholder !== undefined) {
throw new Error('You must provide a valid element as a placeholder or set ot to undefined.');
}
// if no placeholder element is given
if (placeholder === undefined) {
if (['UL', 'OL'].includes(sortableElement.tagName)) {
placeholder = document.createElement('li');
}
else if (['TABLE', 'TBODY'].includes(sortableElement.tagName)) {
placeholder = document.createElement('tr');
// set colspan to always all rows, otherwise the item can only be dropped in first column
placeholder.innerHTML = '<td colspan="100"></td>';
}
else {
placeholder = document.createElement('div');
}
}
// add classes to placeholder
if (typeof placeholderClass === 'string') {
(_a = placeholder.classList).add.apply(_a, placeholderClass.split(' '));
}
return placeholder;
});
/* eslint-env browser */
/**
* Get height of an element including padding
* @param {HTMLElement} element an dom element
*/
var _getElementHeight = (function (element) {
if (!(element instanceof HTMLElement)) {
throw new Error('You must provide a valid dom element');
}
// get calculated style of element
var style = window.getComputedStyle(element);
// pick applicable properties, convert to int and reduce by adding
return ['height', 'padding-top', 'padding-bottom']
.map(function (key) {
var int = parseInt(style.getPropertyValue(key), 10);
return isNaN(int) ? 0 : int;
})
.reduce(function (sum, value) { return sum + value; });
});
/* eslint-env browser */
/**
* get handle or return item
* @param {Array<HTMLElement>} items
* @param {string} selector
*/
var _getHandles = (function (items, selector) {
if (!(items instanceof Array)) {
throw new Error('You must provide a Array of HTMLElements to be filtered.');
}
if (typeof selector !== 'string') {
return items;
}
return items
// remove items without handle from array
.filter(function (item) {
return item.querySelector(selector) instanceof HTMLElement ||
(item.shadowRoot && item.shadowRoot.querySelector(selector) instanceof HTMLElement);
})
// replace item with handle in array
.map(function (item) {
return item.querySelector(selector) || (item.shadowRoot && item.shadowRoot.querySelector(selector));
});
});
/**
* @param {Event} event
* @returns {HTMLElement}
*/
var getEventTarget = (function (event) {
return (event.composedPath && event.composedPath()[0]) || event.target;
});
/* eslint-env browser */
/**
* defaultDragImage returns the current item as dragged image
* @param {HTMLElement} draggedElement - the item that the user drags
* @param {object} elementOffset - an object with the offsets top, left, right & bottom
* @param {Event} event - the original drag event object
* @return {object} with element, posX and posY properties
*/
var defaultDragImage = function (draggedElement, elementOffset, event) {
return {
element: draggedElement,
posX: event.pageX - elementOffset.left,
posY: event.pageY - elementOffset.top
};
};
/**
* attaches an element as the drag image to an event
* @param {Event} event - the original drag event object
* @param {HTMLElement} draggedElement - the item that the user drags
* @param {Function} customDragImage - function to create a custom dragImage
* @return void
*/
var setDragImage = (function (event, draggedElement, customDragImage) {
// check if event is provided
if (!(event instanceof Event)) {
throw new Error('setDragImage requires a DragEvent as the first argument.');
}
// check if draggedElement is provided
if (!(draggedElement instanceof HTMLElement)) {
throw new Error('setDragImage requires the dragged element as the second argument.');
}
// set default function of none provided
if (!customDragImage) {
customDragImage = defaultDragImage;
}
// check if setDragImage method is available
if (event.dataTransfer && event.dataTransfer.setDragImage) {
// get the elements offset
var elementOffset = _offset(draggedElement);
// get the dragImage
var dragImage = customDragImage(draggedElement, elementOffset, event);
// check if custom function returns correct values
if (!(dragImage.element instanceof HTMLElement) || typeof dragImage.posX !== 'number' || typeof dragImage.posY !== 'number') {
throw new Error('The customDragImage function you provided must return and object with the properties element[string], posX[integer], posY[integer].');
}
// needs to be set for HTML5 drag & drop to work
event.dataTransfer.effectAllowed = 'copyMove';
// Firefox requires it to use the event target's id for the data
event.dataTransfer.setData('text/plain', getEventTarget(event).id);
// set the drag image on the event
event.dataTransfer.setDragImage(dragImage.element, dragImage.posX, dragImage.posY);
}
});
/**
* Check if curList accepts items from destList
* @param {sortable} destination the container an item is move to
* @param {sortable} origin the container an item comes from
*/
var _listsConnected = (function (destination, origin) {
// check if valid sortable
if (destination.isSortable === true) {
var acceptFrom = store(destination).getConfig('acceptFrom');
// check if acceptFrom is valid
if (acceptFrom !== null && acceptFrom !== false && typeof acceptFrom !== 'string') {
throw new Error('HTML5Sortable: Wrong argument, "acceptFrom" must be "null", "false", or a valid selector string.');
}
if (acceptFrom !== null) {
return acceptFrom !== false && acceptFrom.split(',').filter(function (sel) {
return sel.length > 0 && origin.matches(sel);
}).length > 0;
}
// drop in same list
if (destination === origin) {
return true;
}
// check if lists are connected with connectWith
if (store(destination).getConfig('connectWith') !== undefined && store(destination).getConfig('connectWith') !== null) {
return store(destination).getConfig('connectWith') === store(origin).getConfig('connectWith');
}
}
return false;
});
/**
* default configurations
*/
var defaultConfiguration = {
items: null,
// deprecated
connectWith: null,
// deprecated
disableIEFix: null,
acceptFrom: null,
copy: false,
placeholder: null,
placeholderClass: 'sortable-placeholder',
draggingClass: 'sortable-dragging',
hoverClass: false,
debounce: 0,
throttleTime: 100,
maxItems: 0,
itemSerializer: undefined,
containerSerializer: undefined,
customDragImage: null
};
/**
* make sure a function is only called once within the given amount of time
* @param {Function} fn the function to throttle
* @param {number} threshold time limit for throttling
*/
// must use function to keep this context
function _throttle (fn, threshold) {
var _this = this;
if (threshold === void 0) { threshold = 250; }
// check function
if (typeof fn !== 'function') {
throw new Error('You must provide a function as the first argument for throttle.');
}
// check threshold
if (typeof threshold !== 'number') {
throw new Error('You must provide a number as the second argument for throttle.');
}
var lastEventTimestamp = null;
return function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
var now = Date.now();
if (lastEventTimestamp === null || now - lastEventTimestamp >= threshold) {
lastEventTimestamp = now;
fn.apply(_this, args);
}
};
}
/* eslint-env browser */
/**
* enable or disable hoverClass on mouseenter/leave if container Items
* @param {sortable} sortableContainer a valid sortableContainer
* @param {boolean} enable enable or disable event
*/
// export default (sortableContainer: sortable, enable: boolean) => {
var enableHoverClass = (function (sortableContainer, enable) {
if (typeof store(sortableContainer).getConfig('hoverClass') === 'string') {
var hoverClasses_1 = store(sortableContainer).getConfig('hoverClass').split(' ');
// add class on hover
if (enable === true) {
addEventListener(sortableContainer, 'mousemove', _throttle(function (event) {
// check of no mouse button was pressed when mousemove started == no drag
if (event.buttons === 0) {
_filter(sortableContainer.children, store(sortableContainer).getConfig('items')).forEach(function (item) {
var _a, _b;
if (item !== event.target) {
(_a = item.classList).remove.apply(_a, hoverClasses_1);
}
else {
(_b = item.classList).add.apply(_b, hoverClasses_1);
}
});
}
}, store(sortableContainer).getConfig('throttleTime')));
// remove class on leave
addEventListener(sortableContainer, 'mouseleave', function () {
_filter(sortableContainer.children, store(sortableContainer).getConfig('items')).forEach(function (item) {
var _a;
(_a = item.classList).remove.apply(_a, hoverClasses_1);
});
});
// remove events
}
else {
removeEventListener(sortableContainer, 'mousemove');
removeEventListener(sortableContainer, 'mouseleave');
}
}
});
/* eslint-env browser */
/*
* variables global to the plugin
*/
var dragging;
var draggingHeight;
/*
* Keeps track of the initialy selected list, where 'dragstart' event was triggered
* It allows us to move the data in between individual Sortable List instances
*/
// Origin List - data from before any item was changed
var originContainer;
var originIndex;
var originElementIndex;
var originItemsBeforeUpdate;
// Previous Sortable Container - we dispatch as sortenter event when a
// dragged item enters a sortableContainer for the first time
var previousContainer;
// Destination List - data from before any item was changed
var destinationItemsBeforeUpdate;
/**
* remove event handlers from items
* @param {Array|NodeList} items
*/
var _removeItemEvents = function (items) {
removeEventListener(items, 'dragstart');
removeEventListener(items, 'dragend');
removeEventListener(items, 'dragover');
removeEventListener(items, 'dragenter');
removeEventListener(items, 'drop');
removeEventListener(items, 'mouseenter');
removeEventListener(items, 'mouseleave');
};
/**
* _getDragging returns the current element to drag or
* a copy of the element.
* Is Copy Active for sortable
* @param {HTMLElement} draggedItem - the item that the user drags
* @param {HTMLElement} sortable a single sortable
*/
var _getDragging = function (draggedItem, sortable) {
var ditem = draggedItem;
if (store(sortable).getConfig('copy') === true) {
ditem = draggedItem.cloneNode(true);
addAttribute(ditem, 'aria-copied', 'true');
draggedItem.parentElement.appendChild(ditem);
ditem.style.display = 'none';
ditem.oldDisplay = draggedItem.style.display;
}
return ditem;
};
/**
* Remove data from sortable
* @param {HTMLElement} sortable a single sortable
*/
var _removeSortableData = function (sortable) {
removeData(sortable);
removeAttribute(sortable, 'aria-dropeffect');
};
/**
* Remove data from items
* @param {Array<HTMLElement>|HTMLElement} items
*/
var _removeItemData = function (items) {
removeAttribute(items, 'aria-grabbed');
removeAttribute(items, 'aria-copied');
removeAttribute(items, 'draggable');
removeAttribute(items, 'role');
};
/**
* find sortable from element. travels up parent element until found or null.
* @param {HTMLElement} element a single sortable
* @param {Event} event - the current event. We need to pass it to be able to
* find Sortable whith shadowRoot (document fragment has no parent)
*/
function findSortable(element, event) {
if (event.composedPath) {
return event.composedPath().find(function (el) { return el.isSortable; });
}
while (element.isSortable !== true) {
element = element.parentElement;
}
return element;
}
/**
* Dragging event is on the sortable element. finds the top child that
* contains the element.
* @param {HTMLElement} sortableElement a single sortable
* @param {HTMLElement} element is that being dragged
*/
function findDragElement(sortableElement, element) {
var options = addData(sortableElement, 'opts');
var items = _filter(sortableElement.children, options.items);
var itemlist = items.filter(function (ele) {
return ele.contains(element) || (ele.shadowRoot && ele.shadowRoot.contains(element));
});
return itemlist.length > 0 ? itemlist[0] : element;
}
/**
* Destroy the sortable
* @param {HTMLElement} sortableElement a single sortable
*/
var _destroySortable = function (sortableElement) {
var opts = addData(sortableElement, 'opts') || {};
var items = _filter(sortableElement.children, opts.items);
var handles = _getHandles(items, opts.handle);
// remove event handlers & data from sortable
removeEventListener(sortableElement, 'dragover');
removeEventListener(sortableElement, 'dragenter');
removeEventListener(sortableElement, 'drop');
// remove event data from sortable
_removeSortableData(sortableElement);
// remove event handlers & data from items
removeEventListener(handles, 'mousedown');
_removeItemEvents(items);
_removeItemData(items);
};
/**
* Enable the sortable
* @param {HTMLElement} sortableElement a single sortable
*/
var _enableSortable = function (sortableElement) {
var opts = addData(sortableElement, 'opts');
var items = _filter(sortableElement.children, opts.items);
var handles = _getHandles(items, opts.handle);
addAttribute(sortableElement, 'aria-dropeffect', 'move');
addData(sortableElement, '_disabled', 'false');
addAttribute(handles, 'draggable', 'true');
// @todo: remove this fix
// IE FIX for ghost
// can be disabled as it has the side effect that other events
// (e.g. click) will be ignored
if (opts.disableIEFix === false) {
var spanEl = (document || window.document).createElement('span');
if (typeof spanEl.dragDrop === 'function') {
addEventListener(handles, 'mousedown', function () {
if (items.indexOf(this) !== -1) {
this.dragDrop();
}
else {
var parent = this.parentElement;
while (items.indexOf(parent) === -1) {
parent = parent.parentElement;
}
parent.dragDrop();
}
});
}
}
};
/**
* Disable the sortable
* @param {HTMLElement} sortableElement a single sortable
*/
var _disableSortable = function (sortableElement) {
var opts = addData(sortableElement, 'opts');
var items = _filter(sortableElement.children, opts.items);
var handles = _getHandles(items, opts.handle);
addAttribute(sortableElement, 'aria-dropeffect', 'none');
addData(sortableElement, '_disabled', 'true');
addAttribute(handles, 'draggable', 'false');
removeEventListener(handles, 'mousedown');
};
/**
* Reload the sortable
* @param {HTMLElement} sortableElement a single sortable
* @description events need to be removed to not be double bound
*/
var _reloadSortable = function (sortableElement) {
var opts = addData(sortableElement, 'opts');
var items = _filter(sortableElement.children, opts.items);
var handles = _getHandles(items, opts.handle);
addData(sortableElement, '_disabled', 'false');
// remove event handlers from items
_removeItemEvents(items);
removeEventListener(handles, 'mousedown');
// remove event handlers from sortable
removeEventListener(sortableElement, 'dragover');
removeEventListener(sortableElement, 'dragenter');
removeEventListener(sortableElement, 'drop');
};
/**
* Public sortable object
* @param {Array|NodeList} sortableElements
* @param {object|string} options|method
*/
function sortable(sortableElements, options) {
// get method string to see if a method is called
var method = String(options);
options = options || {};
// check if the user provided a selector instead of an element
if (typeof sortableElements === 'string') {
sortableElements = document.querySelectorAll(sortableElements);
}
// if the user provided an element, return it in an array to keep the return value consistant
if (sortableElements instanceof HTMLElement) {
sortableElements = [sortableElements];
}
sortableElements = Array.prototype.slice.call(sortableElements);
if (/serialize/.test(method)) {
return sortableElements.map(function (sortableContainer) {
var opts = addData(sortableContainer, 'opts');
return _serialize(sortableContainer, opts.itemSerializer, opts.containerSerializer);
});
}
sortableElements.forEach(function (sortableElement) {
if (/enable|disable|destroy/.test(method)) {
return sortable[method](sortableElement);
}
// log deprecation
['connectWith', 'disableIEFix'].forEach(function (configKey) {
if (options.hasOwnProperty(configKey) && options[configKey] !== null) {
console.warn("HTML5Sortable: You are using the deprecated configuration \"" + configKey + "\". This will be removed in an upcoming version, make sure to migrate to the new options when updating.");
}
});
// merge options with default options
options = Object.assign({}, defaultConfiguration, store(sortableElement).config, options);
// init data store for sortable
store(sortableElement).config = options;
// set options on sortable
addData(sortableElement, 'opts', options);
// property to define as sortable
sortableElement.isSortable = true;
// reset sortable
_reloadSortable(sortableElement);
// initialize
var listItems = _filter(sortableElement.children, options.items);
// create element if user defined a placeholder element as a string
var customPlaceholder;
if (options.placeholder !== null && options.placeholder !== undefined) {
var tempContainer = document.createElement(sortableElement.tagName);
if (options.placeholder instanceof HTMLElement) {
tempContainer.appendChild(options.placeholder);
}
else {
tempContainer.innerHTML = options.placeholder;
}
customPlaceholder = tempContainer.children[0];
}
// add placeholder
store(sortableElement).placeholder = _makePlaceholder(sortableElement, customPlaceholder, options.placeholderClass);
addData(sortableElement, 'items', options.items);
if (options.acceptFrom) {
addData(sortableElement, 'acceptFrom', options.acceptFrom);
}
else if (options.connectWith) {
addData(sortableElement, 'connectWith', options.connectWith);
}
_enableSortable(sortableElement);
addAttribute(listItems, 'role', 'option');
addAttribute(listItems, 'aria-grabbed', 'false');
// enable hover class
enableHoverClass(sortableElement, true);
/*
Handle drag events on draggable items
Handle is set at the sortableElement level as it will bubble up
from the item
*/
addEventListener(sortableElement, 'dragstart', function (e) {
// ignore dragstart events
var target = getEventTarget(e);
if (target.isSortable === true) {
return;
}
e.stopImmediatePropagation();
if ((options.handle && !target.matches(options.handle)) || target.getAttribute('draggable') === 'false') {
return;
}
var sortableContainer = findSortable(target, e);
var dragItem = findDragElement(sortableContainer, target);
// grab values
originItemsBeforeUpdate = _filter(sortableContainer.children, options.items);
originIndex = originItemsBeforeUpdate.indexOf(dragItem);
originElementIndex = _index(dragItem, sortableContainer.children);
originContainer = sortableContainer;
// add transparent clone or other ghost to cursor
setDragImage(e, dragItem, options.customDragImage);
// cache selsection & add attr for dragging
draggingHeight = _getElementHeight(dragItem);
dragItem.classList.add(options.draggingClass);
dragging = _getDragging(dragItem, sortableContainer);
addAttribute(dragging, 'aria-grabbed', 'true');
// dispatch sortstart event on each element in group
sortableContainer.dispatchEvent(new CustomEvent('sortstart', {
detail: {
origin: {
elementIndex: originElementIndex,
index: originIndex,
container: originContainer
},
item: dragging,
originalTarget: target
}
}));
});
/*
We are capturing targetSortable before modifications with 'dragenter' event
*/
addEventListener(sortableElement, 'dragenter', function (e) {
var target = getEventTarget(e);
var sortableContainer = findSortable(target, e);
if (sortableContainer && sortableContainer !== previousContainer) {
destinationItemsBeforeUpdate = _filter(sortableContainer.children, addData(sortableContainer, 'items'))
.filter(function (item) { return item !== store(sortableElement).placeholder; });
sortableContainer.dispatchEvent(new CustomEvent('sortenter', {
detail: {
origin: {
elementIndex: originElementIndex,
index: originIndex,
container: originContainer
},
destination: {
container: sortableContainer,
itemsBeforeUpdate: destinationItemsBeforeUpdate
},
item: dragging,
originalTarget: target
}
}));
}
previousContainer = sortableContainer;
});
/*
* Dragend Event - https://developer.mozilla.org/en-US/docs/Web/Events/dragend
* Fires each time dragEvent end, or ESC pressed
* We are using it to clean up any draggable elements and placeholders
*/
addEventListener(sortableElement, 'dragend', function (e) {
if (!dragging) {
return;
}
dragging.classList.remove(options.draggingClass);
addAttribute(dragging, 'aria-grabbed', 'false');
if (dragging.getAttribute('aria-copied') === 'true' && addData(dragging, 'dropped') !== 'true') {