-
Notifications
You must be signed in to change notification settings - Fork 420
/
slick.gridmenu.js
462 lines (404 loc) · 16.1 KB
/
slick.gridmenu.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
/***
* A control to add a Grid Menu (hambuger menu on top-right of the grid)
*
* USAGE:
*
* Add the slick.gridmenu.(js|css) files and register it with the grid.
*
* To specify a menu in a column header, extend the column definition like so:
* var gridMenuControl = new Slick.Controls.GridMenu(columns, grid, options);
*
* Available grid options, by defining a gridMenu object:
*
* var options = {
* enableCellNavigation: true,
* gridMenu: {
* customTitle: "Custom Menus", // default to empty string
* columnTitle: "Columns", // default to empty string
* iconImage: "../images/drag-handle.png", // this is the Grid Menu icon (hamburger icon)
* iconCssClass: "fa fa-bars", // you can provide iconImage OR iconCssClass
* leaveOpen: false, // do we want to leave the Grid Menu open after a command execution? (false by default)
* menuWidth: 18, // width that will be use to resize the column header container (18 by default)
* resizeOnShowHeaderRow: false, // false by default
*
* // the last 2 checkboxes titles
* hideForceFitButton: false, // show/hide checkbox near the end "Force Fit Columns"
* hideSyncResizeButton: false, // show/hide checkbox near the end "Synchronous Resize"
* forceFitTitle: "Force fit columns", // default to "Force fit columns"
* syncResizeTitle: "Synchronous resize", // default to "Synchronous resize"
*
* customItems: [
* {
* // custom menu item options
* },
* {
* // custom menu item options
* }
* ]
* }
* };
*
*
* Available custom menu item options:
* title: Menu item text.
* divider: Whether the current item is a divider, not an actual command.
* disabled: Whether the item is disabled.
* tooltip: Item tooltip.
* command: A command identifier to be passed to the onCommand event handlers.
* iconCssClass: A CSS class to be added to the menu item icon.
* iconImage: A url to the icon image.
*
*
* The plugin exposes the following events:
* onBeforeMenuShow: Fired before the menu is shown. You can customize the menu or dismiss it by returning false.
* * ONLY works with a jQuery event (as per slick.core code), so we cannot notify when it's a button event (when grid menu is attached to an external button, not the hamburger menu)
* Event args:
* grid: Reference to the grid.
* column: Column definition.
* menu: Menu options. Note that you can change the menu items here.
*
* onMenuClose: Fired when the menu is closing.
* Event args:
* grid: Reference to the grid.
* column: Column definition.
* menu: Menu options. Note that you can change the menu items here.
*
* onCommand: Fired on menu item click for buttons with 'command' specified.
* Event args:
* grid: Reference to the grid.
* column: Column definition.
* command: Button command identified.
* button: Button options. Note that you can change the button options in your
* event handler, and the column header will be automatically updated to
* reflect them. This is useful if you want to implement something like a
* toggle button.
*
*
* @param options {Object} Options:
* buttonCssClass: an extra CSS class to add to the menu button
* buttonImage: a url to the menu button image (default '../images/down.gif')
* @class Slick.Controls.GridMenu
* @constructor
*/
'use strict';
(function ($) {
// register namespace
$.extend(true, window, {
"Slick": {
"Controls": {
"GridMenu": SlickGridMenu
}
}
});
function SlickGridMenu(columns, grid, options) {
var _grid = grid;
var _gridOptions;
var _gridUid = (grid && grid.getUID) ? grid.getUID() : '';
var _isMenuOpen = false;
var _options = options;
var _self = this;
var $customTitleElm;
var $columnTitleElm;
var $list;
var $button;
var $menu;
var columnCheckboxes;
var _defaults = {
hideForceFitButton: false,
hideSyncResizeButton: false,
fadeSpeed: 250,
forceFitTitle: "Force fit columns",
menuWidth: 18,
resizeOnShowHeaderRow: false,
syncResizeTitle: "Synchronous resize"
};
function init(grid) {
_gridOptions = grid.getOptions();
var gridMenuWidth = (_options.gridMenu && _options.gridMenu.menuWidth) || _defaults.menuWidth;
var $header;
if (_gridOptions && _gridOptions.frozenColumn && _gridOptions.frozenColumn >= 0) {
$header = $('.' + _gridUid + ' .slick-header-right');
} else {
$header = $('.' + _gridUid + ' .slick-header-left');
}
$header.attr('style', 'width: calc(100% - ' + gridMenuWidth + 'px)');
// subscribe to the grid, when it's destroyed, we should also destroy the Grid Menu
grid.onBeforeDestroy.subscribe(destroy);
// if header row is enabled, we need to resize it's width also
var enableResizeHeaderRow = (_options.gridMenu && _options.gridMenu.resizeOnShowHeaderRow != undefined) ? _options.gridMenu.resizeOnShowHeaderRow : _defaults.resizeOnShowHeaderRow;
if (enableResizeHeaderRow && _options.showHeaderRow) {
var $headerrow = $('.' + _gridUid + '.slick-headerrow');
$headerrow.attr('style', 'width: calc(100% - ' + gridMenuWidth + 'px)');
}
$button = $('<button class="slick-gridmenu-button"/>');
if (_options.gridMenu && _options.gridMenu.iconCssClass) {
$button.addClass(_options.gridMenu.iconCssClass);
} else {
var iconImage = (_options.gridMenu && _options.gridMenu.iconImage) ? _options.gridMenu.iconImage : "../images/drag-handle.png";
var $btnImage = $('<img src="' + iconImage + '"/>');
$btnImage.appendTo($button);
}
$button.insertBefore($header);
$menu = $('<div class="slick-gridmenu ' + _gridUid + '" style="display: none" />').appendTo(document.body);
$('<button type="button" class="close" data-dismiss="slick-gridmenu" aria-label="Close"><span class="close" aria-hidden="true">×</span></button>').appendTo($menu);
var $customMenu = $('<div class="slick-gridmenu-custom" />');
$customMenu.appendTo($menu);
// user could pass a title on top of the custom section
if (_options.gridMenu && _options.gridMenu.customTitle) {
$customTitleElm = $('<div class="title"/>').append(_options.gridMenu.customTitle);
$customTitleElm.appendTo($customMenu);
}
populateCustomMenus(_options, $customMenu);
populateColumnPicker();
// Hide the menu on outside click.
$(document.body).on("mousedown." + _gridUid, handleBodyMouseDown);
// destroy the picker if user leaves the page
$(window).on("beforeunload", destroy);
// add on click handler for the Grid Menu itself
$button.on("click." + _gridUid, showGridMenu);
}
function destroy() {
_self.onBeforeMenuShow.unsubscribe();
_self.onMenuClose.unsubscribe();
_self.onCommand.unsubscribe();
_self.onColumnsChanged.unsubscribe();
_grid.onColumnsReordered.unsubscribe(updateColumnOrder);
_grid.onBeforeDestroy.unsubscribe();
$(document.body).off("mousedown." + _gridUid, handleBodyMouseDown);
$("div.slick-gridmenu." + _gridUid).hide(_options.fadeSpeed);
$menu.remove();
$button.remove();
}
function populateCustomMenus(options, $customMenu) {
// Construct the custom menu items.
if (!options.gridMenu || !options.gridMenu.customItems) {
return;
}
for (var i = 0, ln = options.gridMenu.customItems.length; i < ln; i++) {
var item = options.gridMenu.customItems[i];
var $li = $("<div class='slick-gridmenu-item'></div>")
.data("command", item.command || '')
.data("item", item)
.on("click", handleMenuItemClick)
.appendTo($customMenu);
if (item.disabled) {
$li.addClass("slick-gridmenu-item-disabled");
}
if (item.divider) {
$li.addClass("slick-gridmenu-item-divider");
continue;
}
if (item.tooltip) {
$li.attr("title", item.tooltip);
}
var $icon = $("<div class='slick-gridmenu-icon'></div>")
.appendTo($li);
if (item.iconCssClass) {
$icon.addClass(item.iconCssClass);
}
if (item.iconImage) {
$icon.css("background-image", "url(" + item.iconImage + ")");
}
var $content = $("<span class='slick-gridmenu-content'></span>")
.text(item.title)
.appendTo($li);
}
}
/** Build the column picker, the code comes almost untouched from the file "slick.columnpicker.js" */
function populateColumnPicker() {
_grid.onColumnsReordered.subscribe(updateColumnOrder);
_options = $.extend({}, _defaults, _options);
// user could pass a title on top of the columns list
if (_options.gridMenu && _options.gridMenu.columnTitle) {
$columnTitleElm = $('<div class="title"/>').append(_options.gridMenu.columnTitle);
$columnTitleElm.appendTo($menu);
}
$menu.on("click", updateColumn);
$list = $('<span class="slick-gridmenu-list" />');
}
function showGridMenu(e) {
e.preventDefault();
$list.empty();
updateColumnOrder();
columnCheckboxes = [];
// notify of the onBeforeMenuShow only works when it's a jQuery event (as per slick.core code)
// this mean that we cannot notify when the grid menu is attach to a button event
if (typeof e.isPropagationStopped === "function") {
if (_self.onBeforeMenuShow.notify({
"grid": _grid,
"menu": $menu
}, e, _self) == false) {
return;
}
}
var $li, $input, excludeCssClass;
for (var i = 0; i < columns.length; i++) {
excludeCssClass = columns[i].excludeFromGridMenu ? "hidden" : "";
$li = $('<li class="' + excludeCssClass + '" />').appendTo($list);
$input = $("<input type='checkbox' />").data("column-id", columns[i].id);
columnCheckboxes.push($input);
if (_grid.getColumnIndex(columns[i].id) != null) {
$input.attr("checked", "checked");
}
$("<label />")
.html(columns[i].name)
.prepend($input)
.appendTo($li);
}
if (_options.gridMenu && (!_options.gridMenu.hideForceFitButton || !_options.gridMenu.hideSyncResizeButton)) {
$("<hr/>").appendTo($list);
}
if (!(_options.gridMenu && _options.gridMenu.hideForceFitButton)) {
var forceFitTitle = (_options.gridMenu && _options.gridMenu.forceFitTitle) || _defaults.forceFitTitle;
$li = $("<li />").appendTo($list);
$input = $("<input type='checkbox' />").data("option", "autoresize");
$("<label />")
.text(forceFitTitle)
.prepend($input)
.appendTo($li);
if (_grid.getOptions().forceFitColumns) {
$input.attr("checked", "checked");
}
}
if (!(_options.gridMenu && _options.gridMenu.hideSyncResizeButton)) {
var syncResizeTitle = (_options.gridMenu && _options.gridMenu.syncResizeTitle) || _defaults.syncResizeTitle;
$li = $("<li />").appendTo($list);
$input = $("<input type='checkbox' />").data("option", "syncresize");
$("<label />")
.text(syncResizeTitle)
.prepend($input)
.appendTo($li);
if (_grid.getOptions().syncColumnCellResize) {
$input.attr("checked", "checked");
}
}
$menu
.css("top", e.pageY + 10)
.css("left", e.pageX - $menu.width())
.css("max-height", $(window).height() - e.pageY - 10)
.fadeIn(_options.fadeSpeed);
$list.appendTo($menu);
_isMenuOpen = true;
}
function handleBodyMouseDown(e) {
if (($menu && $menu[0] != e.target && !$.contains($menu[0], e.target) && _isMenuOpen) || e.target.className == "close") {
hideMenu(e);
}
}
function handleMenuItemClick(e) {
var command = $(this).data("command");
var item = $(this).data("item");
if (item.disabled || item.divider) {
return;
}
// does the user want to leave open the Grid Menu after executing a command?
var leaveOpen = (_options.gridMenu && _options.gridMenu.leaveOpen) ? true : false;
if (!leaveOpen) {
hideMenu(e);
}
if (command != null && command != '') {
_self.onCommand.notify({
"grid": _grid,
"command": command,
"item": item
}, e, _self);
}
// Stop propagation so that it doesn't register as a header click event.
e.preventDefault();
e.stopPropagation();
}
function hideMenu(e) {
if ($menu) {
$menu.hide(_options.fadeSpeed);
_isMenuOpen = false;
if (_self.onMenuClose.notify({
"grid": _grid,
"menu": $menu
}, e, _self) == false) {
return;
}
}
}
/** Update the Titles of each sections (command, customTitle, ...) */
function updateAllTitles(gridMenuOptions) {
if ($customTitleElm && $customTitleElm.text) {
$customTitleElm.text(gridMenuOptions.customTitle);
}
if ($columnTitleElm && $columnTitleElm.text) {
$columnTitleElm.text(gridMenuOptions.columnTitle);
}
}
function updateColumnOrder() {
// Because columns can be reordered, we have to update the `columns`
// to reflect the new order, however we can't just take `grid.getColumns()`,
// as it does not include columns currently hidden by the picker.
// We create a new `columns` structure by leaving currently-hidden
// columns in their original ordinal position and interleaving the results
// of the current column sort.
var current = _grid.getColumns().slice(0);
var ordered = new Array(columns.length);
for (var i = 0; i < ordered.length; i++) {
if (_grid.getColumnIndex(columns[i].id) === undefined) {
// If the column doesn't return a value from getColumnIndex,
// it is hidden. Leave it in this position.
ordered[i] = columns[i];
} else {
// Otherwise, grab the next visible column.
ordered[i] = current.shift();
}
}
columns = ordered;
}
function updateColumn(e) {
if ($(e.target).data("option") == "autoresize") {
if (e.target.checked) {
_grid.setOptions({ forceFitColumns: true });
_grid.autosizeColumns();
} else {
_grid.setOptions({ forceFitColumns: false });
}
return;
}
if ($(e.target).data("option") == "syncresize") {
if (e.target.checked) {
_grid.setOptions({ syncColumnCellResize: true });
} else {
_grid.setOptions({ syncColumnCellResize: false });
}
return;
}
if ($(e.target).is(":checkbox")) {
var visibleColumns = [];
$.each(columnCheckboxes, function (i, e) {
if ($(this).is(":checked")) {
visibleColumns.push(columns[i]);
}
});
if (!visibleColumns.length) {
$(e.target).attr("checked", "checked");
return;
}
_grid.setColumns(visibleColumns);
_self.onColumnsChanged.notify({
"grid": _grid,
"columns": visibleColumns
}, e, _self);
}
}
init(_grid);
function getAllColumns() {
return columns;
}
$.extend(this, {
"init": init,
"getAllColumns": getAllColumns,
"destroy": destroy,
"showGridMenu": showGridMenu,
"updateAllTitles": updateAllTitles,
"onBeforeMenuShow": new Slick.Event(),
"onMenuClose": new Slick.Event(),
"onCommand": new Slick.Event(),
"onColumnsChanged": new Slick.Event()
});
}
})(jQuery);