-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
filters.js
412 lines (356 loc) · 11.7 KB
/
filters.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
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
/**
* @api
*/
define([
'underscore',
'mageUtils',
'uiLayout',
'uiCollection',
'mage/translate',
'jquery'
], function (_, utils, layout, Collection, $t, $) {
'use strict';
/**
* Extracts and formats preview of an element.
*
* @param {Object} elem - Element whose preview should be extracted.
* @returns {Object} Formatted data.
*/
function extractPreview(elem) {
return {
label: elem.label,
preview: elem.getPreview(),
elem: elem
};
}
/**
* Removes empty properties from the provided object.
*
* @param {Object} data - Object to be processed.
* @returns {Object}
*/
function removeEmpty(data) {
var result = utils.mapRecursive(data, utils.removeEmptyValues.bind(utils));
return utils.mapRecursive(result, function (value) {
return _.isString(value) ? value.trim() : value;
});
}
return Collection.extend({
defaults: {
template: 'ui/grid/filters/filters',
stickyTmpl: 'ui/grid/sticky/filters',
_processed: [],
columnsProvider: 'ns = ${ $.ns }, componentType = columns',
bookmarksProvider: 'ns = ${ $.ns }, componentType = bookmark',
applied: {
placeholder: true
},
filters: {
placeholder: true
},
templates: {
filters: {
base: {
parent: '${ $.$data.filters.name }',
name: '${ $.$data.column.index }',
provider: '${ $.$data.filters.name }',
dataScope: '${ $.$data.column.index }',
label: '${ $.$data.column.label }',
imports: {
visible: '${ $.$data.column.name }:visible'
}
},
text: {
component: 'Magento_Ui/js/form/element/abstract',
template: 'ui/grid/filters/field'
},
select: {
component: 'Magento_Ui/js/form/element/select',
template: 'ui/grid/filters/field',
options: '${ JSON.stringify($.$data.column.options) }',
caption: ' '
},
dateRange: {
component: 'Magento_Ui/js/grid/filters/range',
rangeType: 'date'
},
textRange: {
component: 'Magento_Ui/js/grid/filters/range',
rangeType: 'text'
}
}
},
chipsConfig: {
name: '${ $.name }_chips',
provider: '${ $.chipsConfig.name }',
component: 'Magento_Ui/js/grid/filters/chips'
},
listens: {
active: 'updatePreviews',
applied: 'cancel updateActive'
},
statefull: {
applied: true
},
exports: {
applied: '${ $.provider }:params.filters'
},
imports: {
onColumnsUpdate: '${ $.columnsProvider }:elems',
onBackendError: '${ $.provider }:lastError',
bookmarksActiveIndex: '${ $.bookmarksProvider }:activeIndex'
},
modules: {
columns: '${ $.columnsProvider }',
chips: '${ $.chipsConfig.provider }'
}
},
/**
* Initializes filters component.
*
* @returns {Filters} Chainable.
*/
initialize: function () {
_.bindAll(this, 'updateActive');
this._super()
.initChips()
.cancel();
return this;
},
/**
* Initializes observable properties.
*
* @returns {Filters} Chainable.
*/
initObservable: function () {
this._super()
.track({
active: [],
previews: []
});
return this;
},
/**
* Initializes chips component.
*
* @returns {Filters} Chainable.
*/
initChips: function () {
layout([this.chipsConfig]);
this.chips('insertChild', this.name);
return this;
},
/**
* Called when another element was added to filters collection.
*
* @returns {Filters} Chainable.
*/
initElement: function (elem) {
this._super();
elem.on('elems', this.updateActive);
this.updateActive();
return this;
},
/**
* Clears filters data.
*
* @param {Object} [filter] - If provided, then only specified
* filter will be cleared. Otherwise, clears all data.
* @returns {Filters} Chainable.
*/
clear: function (filter) {
filter ?
filter.clear() :
_.invoke(this.active, 'clear');
this.apply();
return this;
},
/**
* Sets filters data to the applied state.
*
* @returns {Filters} Chainable.
*/
apply: function () {
this.set('applied', removeEmpty(this.filters));
return this;
},
/**
* Resets filters to the last applied state.
*
* @returns {Filters} Chainable.
*/
cancel: function () {
this.set('filters', utils.copy(this.applied));
return this;
},
/**
* Sets provided data to filter components (without applying it).
*
* @param {Object} data - Filters data.
* @param {Boolean} [partial=false] - Flag that defines whether
* to completely replace current filters data or to extend it.
* @returns {Filters} Chainable.
*/
setData: function (data, partial) {
var filters = partial ? this.filters : {};
data = utils.extend({}, filters, data);
this.set('filters', data);
return this;
},
/**
* Creates instance of a filter associated with the provided column.
*
* @param {Column} column - Column component for which to create a filter.
* @returns {Filters} Chainable.
*/
addFilter: function (column) {
var index = column.index,
processed = this._processed,
filter;
if (!column.filter || _.contains(processed, index)) {
return this;
}
filter = this.buildFilter(column);
processed.push(index);
layout([filter]);
return this;
},
/**
* Creates filter component configuration associated with the provided column.
*
* @param {Column} column - Column component whith a basic filter declaration.
* @returns {Object} Filters' configuration.
*/
buildFilter: function (column) {
var filters = this.templates.filters,
filter = column.filter,
type = filters[filter.filterType];
if (_.isObject(filter) && type) {
filter = utils.extend({}, type, filter);
} else if (_.isString(filter)) {
filter = filters[filter];
}
filter = utils.extend({}, filters.base, filter);
return utils.template(filter, {
filters: this,
column: column
}, true, true);
},
/**
* Returns an array of range filters.
*
* @returns {Array}
*/
getRanges: function () {
return this.elems.filter(function (filter) {
return filter.isRange;
});
},
/**
* Returns an array of non-range filters.
*
* @returns {Array}
*/
getPlain: function () {
return this.elems.filter(function (filter) {
return !filter.isRange;
});
},
/**
* Tells wether specified filter should be visible.
*
* @param {Object} filter
* @returns {Boolean}
*/
isFilterVisible: function (filter) {
return filter.visible() || this.isFilterActive(filter);
},
/**
* Checks if specified filter is active.
*
* @param {Object} filter
* @returns {Boolean}
*/
isFilterActive: function (filter) {
return _.contains(this.active, filter);
},
/**
* Checks if collection has visible filters.
*
* @returns {Boolean}
*/
hasVisible: function () {
return this.elems.some(this.isFilterVisible, this);
},
/**
* Finds filters whith a not empty data
* and sets them to the 'active' filters array.
*
* @returns {Filters} Chainable.
*/
updateActive: function () {
var applied = _.keys(this.applied);
this.active = this.elems.filter(function (elem) {
return _.contains(applied, elem.index);
});
return this;
},
/**
* Returns number of applied filters.
*
* @returns {Number}
*/
countActive: function () {
return this.active.length;
},
/**
* Extract previews of a specified filters.
*
* @param {Array} filters - Filters to be processed.
* @returns {Filters} Chainable.
*/
updatePreviews: function (filters) {
var previews = filters.map(extractPreview);
this.previews = _.compact(previews);
return this;
},
/**
* Listener of the columns provider children array changes.
*
* @param {Array} columns - Current columns list.
*/
onColumnsUpdate: function (columns) {
columns.forEach(this.addFilter, this);
},
/**
* Provider ajax error listener.
*
* @param {bool} isError - Selected index of the filter.
*/
onBackendError: function (isError) {
var defaultMessage = 'Something went wrong with processing the default view and we have restored the ' +
'filter to its original state.',
customMessage = 'Something went wrong with processing current custom view and filters have been ' +
'reset to its original state. Please edit filters then click apply.';
if (isError) {
this.clear();
$('body').notification('clear')
.notification('add', {
error: true,
message: $.mage.__(this.bookmarksActiveIndex !== 'default' ? customMessage : defaultMessage),
/**
* @param {String} message
*/
insertMethod: function (message) {
var $wrapper = $('<div/>').html(message);
$('.page-main-actions').after($wrapper);
}
});
}
}
});
});