-
Notifications
You must be signed in to change notification settings - Fork 87
/
sortableComponent.js
188 lines (174 loc) · 6.89 KB
/
sortableComponent.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
sortableComponent.$inject = ['$timeout'];
// The MIT License (MIT)
//
// Copyright (c) 2015-2024 Camptocamp SA
//
// 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.
import angular from 'angular';
import 'jquery-ui/ui/widgets/sortable';
import 'jquery-ui-touch-punch';
/**
* @typedef {Object} miscSortableOptions
* @property {string} [handleClassName]
* @property {string} [draggerClassName]
* @property {string} [placeholderClassName]
*/
/**
* @type {angular.IModule}
* @hidden
*/
const myModule = angular.module('ngeoSortable', []);
/**
* Provides a directive that allows drag-and-dropping DOM items between them.
* It also changes the order of elements in the given array.
*
* It is typically used together with `ng-repeat`, for example for re-ordering
* layers in a map.
*
* Example:
*
* <ul ngeo-sortable="ctrl.layers"
* ngeo-sortable-options="{handleClassName: 'ngeo-sortable-handle'}">
* <li ng-repeat="layer in ctrl.layers">
* <span class="ngeo-sortable-handle">handle</span>{{layer.get('name')}}
* </li>
* </ul>
*
* The value of the "ngeo-sortable" attribute is an expression which evaluates
* to an array (an array of layers in the above example). This is the array
* that is re-ordered after a drag-and-drop.
*
* The element with the class "ngeo-sortable-handle" is the "drag handle".
* It is required.
*
* This directives uses `$watchCollection` to watch the "sortable" array. So
* if some outside code adds/removes elements to/from the "sortable" array,
* the "ngeoSortable" directive will pick it up.
*
* See our live example: [../examples/layerorder.html](../examples/layerorder.html)
*
* @htmlAttribute {import('ol/layer/Base').default[]} ngeo-sortable The layers to sort.
* @htmlAttribute {miscSortableOptions} ngeo-sortable-options The options.
* @htmlAttribute {Function(JQuery, Array)?} ngeo-sortable-callback
* Callback function called after the move end. The Function will be called
* with the element and the sort array as arguments.
* @htmlAttribute {Object?} ngeo-sortable-callback-ctx Context to apply at
* the call of the callback function.
* @param {angular.ITimeoutService} $timeout Angular timeout service.
* @returns {angular.IDirective} The directive specs.
* @ngdoc directive
* @ngname ngeoSortable
*/
function sortableComponent($timeout) {
return {
restrict: 'A',
/**
* @param {angular.IScope} scope Scope.
* @param {JQuery} element Element.
* @param {angular.IAttributes} attrs Attributes.
*/
link: (scope, element, attrs) => {
const sortable = scope.$eval(attrs.ngeoSortable) || [];
console.assert(Array.isArray(sortable));
scope.$watchCollection(
() => sortable,
() => {
sortable.length && $timeout(resetUpDragDrop, 0);
},
);
const optionsObject = scope.$eval(attrs.ngeoSortableOptions);
const options = getOptions(optionsObject);
const callbackFn = scope.$eval(attrs.ngeoSortableCallback);
const callbackCtx = scope.$eval(attrs.ngeoSortableCallbackCtx);
/**
* This function resets drag&drop for the list. It is called each
* time the sortable array changes (see $watchCollection above).
*/
function resetUpDragDrop() {
// Add an index to the sortable to allow sorting of the
// underlying data.
const children = element.children();
for (let i = 0; i < children.length; ++i) {
angular.element(children[i]).data('idx', i);
}
const sortableElement = $(element);
// the element is already sortable; reset it.
if (sortableElement.data('ui-sortable')) {
sortableElement.off('sortupdate');
sortableElement.sortable('destroy');
}
/** @type {JQueryUI.SortableOptions} */
const sortableOptions = {
axis: 'y',
// @ts-ignore: classes is missing?
classes: {
'ui-sortable-helper': options.draggerClassName,
},
};
// CSS class of the handle
if (options.handleClassName) {
sortableOptions.handle = `.${options.handleClassName}`;
}
// Placeholder for the item being dragged in the sortable list
if (options.placeholderClassName) {
sortableOptions.placeholder = options.placeholderClassName;
sortableOptions.forcePlaceholderSize = true;
}
sortableElement.sortable(sortableOptions);
// This event is triggered when the user stopped sorting and
// the DOM position (i.e. order in the sortable list) has changed.
sortableElement.on('sortupdate', (event, ui) => {
const oldIndex = $(ui.item[0]).data('idx');
const newIndex = ui.item.index();
// Update (data)-index on dom element to its new position
$(ui.item[0]).data('idx', newIndex);
// Move dragged item to new position
scope.$apply(() => {
sortable.splice(newIndex, 0, sortable.splice(oldIndex, 1)[0]);
});
// Call the callback function if it exists.
if (callbackFn instanceof Function) {
callbackFn.apply(callbackCtx, [element, sortable]);
}
});
}
/**
* @param {?} options Options after expression evaluation.
* @returns {miscSortableOptions} Options object.
* @private
*/
function getOptions(options) {
let ret;
const defaultHandleClassName = 'ngeo-sortable-handle';
if (options === undefined) {
ret = {
'handleClassName': defaultHandleClassName,
};
} else {
if (options.handleClassName === undefined) {
options.handleClassName = defaultHandleClassName;
}
ret = /** @type {miscSortableOptions} */ options;
}
return ret;
}
},
};
}
myModule.directive('ngeoSortable', sortableComponent);
export default myModule;