@vaadin/grid 24.0.0-alpha1 → 24.0.0-alpha2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/all-imports.d.ts +10 -0
- package/all-imports.js +11 -0
- package/package.json +11 -10
- package/src/vaadin-grid-data-provider-mixin.js +10 -0
- package/src/vaadin-grid-keyboard-navigation-mixin.js +8 -1
- package/src/vaadin-grid-row-details-mixin.d.ts +1 -5
- package/src/vaadin-grid-sort-mixin.d.ts +9 -0
- package/src/vaadin-grid-sort-mixin.js +18 -5
- package/src/vaadin-grid-sorter.d.ts +6 -1
- package/src/vaadin-grid-sorter.js +14 -1
- package/src/vaadin-grid-tree-column.d.ts +0 -7
- package/src/vaadin-grid-tree-column.js +1 -24
- package/src/vaadin-grid.d.ts +0 -11
- package/src/vaadin-grid.js +0 -15
- package/web-types.json +22 -26
- package/web-types.lit.json +11 -11
package/all-imports.d.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export * from './vaadin-grid-column-group.js';
|
|
2
|
+
export * from './vaadin-grid-column.js';
|
|
3
|
+
export * from './vaadin-grid-filter.js';
|
|
4
|
+
export * from './vaadin-grid-filter-column.js';
|
|
5
|
+
export * from './vaadin-grid-selection-column.js';
|
|
6
|
+
export * from './vaadin-grid-sorter.js';
|
|
7
|
+
export * from './vaadin-grid-sort-column.js';
|
|
8
|
+
export * from './vaadin-grid-tree-column.js';
|
|
9
|
+
export * from './vaadin-grid-tree-toggle.js';
|
|
10
|
+
export * from './vaadin-grid.js';
|
package/all-imports.js
CHANGED
|
@@ -1 +1,12 @@
|
|
|
1
1
|
import './theme/lumo/all-imports.js';
|
|
2
|
+
|
|
3
|
+
export * from './vaadin-grid-column-group.js';
|
|
4
|
+
export * from './vaadin-grid-column.js';
|
|
5
|
+
export * from './vaadin-grid-filter.js';
|
|
6
|
+
export * from './vaadin-grid-filter-column.js';
|
|
7
|
+
export * from './vaadin-grid-selection-column.js';
|
|
8
|
+
export * from './vaadin-grid-sorter.js';
|
|
9
|
+
export * from './vaadin-grid-sort-column.js';
|
|
10
|
+
export * from './vaadin-grid-tree-column.js';
|
|
11
|
+
export * from './vaadin-grid-tree-toggle.js';
|
|
12
|
+
export * from './vaadin-grid.js';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vaadin/grid",
|
|
3
|
-
"version": "24.0.0-
|
|
3
|
+
"version": "24.0.0-alpha2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -20,6 +20,7 @@
|
|
|
20
20
|
"module": "vaadin-grid.js",
|
|
21
21
|
"type": "module",
|
|
22
22
|
"files": [
|
|
23
|
+
"all-imports.d.ts",
|
|
23
24
|
"all-imports.js",
|
|
24
25
|
"lit.d.ts",
|
|
25
26
|
"lit.js",
|
|
@@ -45,17 +46,17 @@
|
|
|
45
46
|
"dependencies": {
|
|
46
47
|
"@open-wc/dedupe-mixin": "^1.3.0",
|
|
47
48
|
"@polymer/polymer": "^3.0.0",
|
|
48
|
-
"@vaadin/checkbox": "24.0.0-
|
|
49
|
-
"@vaadin/component-base": "24.0.0-
|
|
50
|
-
"@vaadin/lit-renderer": "24.0.0-
|
|
51
|
-
"@vaadin/text-field": "24.0.0-
|
|
52
|
-
"@vaadin/vaadin-lumo-styles": "24.0.0-
|
|
53
|
-
"@vaadin/vaadin-material-styles": "24.0.0-
|
|
54
|
-
"@vaadin/vaadin-themable-mixin": "24.0.0-
|
|
49
|
+
"@vaadin/checkbox": "24.0.0-alpha2",
|
|
50
|
+
"@vaadin/component-base": "24.0.0-alpha2",
|
|
51
|
+
"@vaadin/lit-renderer": "24.0.0-alpha2",
|
|
52
|
+
"@vaadin/text-field": "24.0.0-alpha2",
|
|
53
|
+
"@vaadin/vaadin-lumo-styles": "24.0.0-alpha2",
|
|
54
|
+
"@vaadin/vaadin-material-styles": "24.0.0-alpha2",
|
|
55
|
+
"@vaadin/vaadin-themable-mixin": "24.0.0-alpha2"
|
|
55
56
|
},
|
|
56
57
|
"devDependencies": {
|
|
57
58
|
"@esm-bundle/chai": "^4.3.4",
|
|
58
|
-
"@vaadin/polymer-legacy-adapter": "24.0.0-
|
|
59
|
+
"@vaadin/polymer-legacy-adapter": "24.0.0-alpha2",
|
|
59
60
|
"@vaadin/testing-helpers": "^0.3.2",
|
|
60
61
|
"lit": "^2.0.0",
|
|
61
62
|
"sinon": "^13.0.2"
|
|
@@ -64,5 +65,5 @@
|
|
|
64
65
|
"web-types.json",
|
|
65
66
|
"web-types.lit.json"
|
|
66
67
|
],
|
|
67
|
-
"gitHead": "
|
|
68
|
+
"gitHead": "0c16c01a6807e629a84f5a982793afecc1a7ced0"
|
|
68
69
|
}
|
|
@@ -193,6 +193,7 @@ export const DataProviderMixin = (superClass) =>
|
|
|
193
193
|
itemHasChildrenPath: {
|
|
194
194
|
type: String,
|
|
195
195
|
value: 'children',
|
|
196
|
+
observer: '__itemHasChildrenPathChanged',
|
|
196
197
|
},
|
|
197
198
|
|
|
198
199
|
/**
|
|
@@ -236,6 +237,15 @@ export const DataProviderMixin = (superClass) =>
|
|
|
236
237
|
this._effectiveSize = this._cache.effectiveSize;
|
|
237
238
|
}
|
|
238
239
|
|
|
240
|
+
/** @private */
|
|
241
|
+
__itemHasChildrenPathChanged(value, oldValue) {
|
|
242
|
+
if (!oldValue && value === 'children') {
|
|
243
|
+
// Avoid an unnecessary content update on init.
|
|
244
|
+
return;
|
|
245
|
+
}
|
|
246
|
+
this.requestContentUpdate();
|
|
247
|
+
}
|
|
248
|
+
|
|
239
249
|
/**
|
|
240
250
|
* @param {number} index
|
|
241
251
|
* @param {HTMLElement} el
|
|
@@ -732,7 +732,14 @@ export const KeyboardNavigationMixin = (superClass) =>
|
|
|
732
732
|
const cell = e.composedPath()[0];
|
|
733
733
|
if (cell._content && cell._content.firstElementChild) {
|
|
734
734
|
const wasNavigating = this.hasAttribute('navigating');
|
|
735
|
-
cell._content.firstElementChild.
|
|
735
|
+
cell._content.firstElementChild.dispatchEvent(
|
|
736
|
+
new MouseEvent('click', {
|
|
737
|
+
shiftKey: e.shiftKey,
|
|
738
|
+
bubbles: true,
|
|
739
|
+
composed: true,
|
|
740
|
+
cancelable: true,
|
|
741
|
+
}),
|
|
742
|
+
);
|
|
736
743
|
this.toggleAttribute('navigating', wasNavigating);
|
|
737
744
|
}
|
|
738
745
|
}
|
|
@@ -6,11 +6,7 @@
|
|
|
6
6
|
import type { Constructor } from '@open-wc/dedupe-mixin';
|
|
7
7
|
import type { Grid, GridItemModel } from './vaadin-grid.js';
|
|
8
8
|
|
|
9
|
-
export type GridRowDetailsRenderer<TItem> = (
|
|
10
|
-
root: HTMLElement,
|
|
11
|
-
grid?: Grid<TItem>,
|
|
12
|
-
model?: GridItemModel<TItem>,
|
|
13
|
-
) => void;
|
|
9
|
+
export type GridRowDetailsRenderer<TItem> = (root: HTMLElement, grid: Grid<TItem>, model: GridItemModel<TItem>) => void;
|
|
14
10
|
|
|
15
11
|
export declare function RowDetailsMixin<TItem, T extends Constructor<HTMLElement>>(
|
|
16
12
|
base: T,
|
|
@@ -36,4 +36,13 @@ export declare class SortMixinClass {
|
|
|
36
36
|
* @attr {string} multi-sort-priority
|
|
37
37
|
*/
|
|
38
38
|
multiSortPriority: 'append' | 'prepend';
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.
|
|
42
|
+
* Shift + Space does the same action via keyboard. This property has precedence over the
|
|
43
|
+
* `multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.
|
|
44
|
+
*
|
|
45
|
+
* @attr {boolean} multi-sort-on-shift-click
|
|
46
|
+
*/
|
|
47
|
+
multiSortOnShiftClick: boolean;
|
|
39
48
|
}
|
|
@@ -42,6 +42,19 @@ export const SortMixin = (superClass) =>
|
|
|
42
42
|
value: () => defaultMultiSortPriority,
|
|
43
43
|
},
|
|
44
44
|
|
|
45
|
+
/**
|
|
46
|
+
* When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.
|
|
47
|
+
* Shift + Space does the same action via keyboard. This property has precedence over the
|
|
48
|
+
* `multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.
|
|
49
|
+
*
|
|
50
|
+
* @attr {boolean} multi-sort-on-shift-click
|
|
51
|
+
* @type {boolean}
|
|
52
|
+
*/
|
|
53
|
+
multiSortOnShiftClick: {
|
|
54
|
+
type: Boolean,
|
|
55
|
+
value: false,
|
|
56
|
+
},
|
|
57
|
+
|
|
45
58
|
/**
|
|
46
59
|
* @type {!Array<!GridSorterDefinition>}
|
|
47
60
|
* @protected
|
|
@@ -81,7 +94,7 @@ export const SortMixin = (superClass) =>
|
|
|
81
94
|
const sorter = e.target;
|
|
82
95
|
e.stopPropagation();
|
|
83
96
|
sorter._grid = this;
|
|
84
|
-
this.__updateSorter(sorter);
|
|
97
|
+
this.__updateSorter(sorter, e.detail.shiftClick);
|
|
85
98
|
this.__applySorters();
|
|
86
99
|
}
|
|
87
100
|
|
|
@@ -126,22 +139,22 @@ export const SortMixin = (superClass) =>
|
|
|
126
139
|
}
|
|
127
140
|
|
|
128
141
|
/** @private */
|
|
129
|
-
__updateSorter(sorter) {
|
|
142
|
+
__updateSorter(sorter, shiftClick) {
|
|
130
143
|
if (!sorter.direction && this._sorters.indexOf(sorter) === -1) {
|
|
131
144
|
return;
|
|
132
145
|
}
|
|
133
146
|
|
|
134
147
|
sorter._order = null;
|
|
135
148
|
|
|
136
|
-
if (this.multiSort) {
|
|
149
|
+
if ((this.multiSort && !this.multiSortOnShiftClick) || (this.multiSortOnShiftClick && shiftClick)) {
|
|
137
150
|
if (this.multiSortPriority === 'append') {
|
|
138
151
|
this.__appendSorter(sorter);
|
|
139
152
|
} else {
|
|
140
153
|
this.__prependSorter(sorter);
|
|
141
154
|
}
|
|
142
|
-
} else if (sorter.direction) {
|
|
155
|
+
} else if (sorter.direction || this.multiSortOnShiftClick) {
|
|
143
156
|
const otherSorters = this._sorters.filter((s) => s !== sorter);
|
|
144
|
-
this._sorters = [sorter];
|
|
157
|
+
this._sorters = sorter.direction ? [sorter] : [];
|
|
145
158
|
otherSorters.forEach((sorter) => {
|
|
146
159
|
sorter._order = null;
|
|
147
160
|
sorter.direction = null;
|
|
@@ -8,13 +8,18 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
|
|
|
8
8
|
|
|
9
9
|
export type GridSorterDirection = 'asc' | 'desc' | null;
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Fired when the `path` or `direction` property changes.
|
|
13
|
+
*/
|
|
14
|
+
export type GridSorterChangedEvent = CustomEvent<{ shiftClick: boolean }>;
|
|
15
|
+
|
|
11
16
|
/**
|
|
12
17
|
* Fired when the `direction` property changes.
|
|
13
18
|
*/
|
|
14
19
|
export type GridSorterDirectionChangedEvent = CustomEvent<{ value: GridSorterDirection }>;
|
|
15
20
|
|
|
16
21
|
export interface GridSorterCustomEventMap {
|
|
17
|
-
'sorter-changed':
|
|
22
|
+
'sorter-changed': GridSorterChangedEvent;
|
|
18
23
|
|
|
19
24
|
'direction-changed': GridSorterDirectionChangedEvent;
|
|
20
25
|
}
|
|
@@ -153,6 +153,12 @@ class GridSorter extends ThemableMixin(DirMixin(PolymerElement)) {
|
|
|
153
153
|
type: Boolean,
|
|
154
154
|
observer: '__isConnectedChanged',
|
|
155
155
|
},
|
|
156
|
+
|
|
157
|
+
/** @private */
|
|
158
|
+
_shiftClick: {
|
|
159
|
+
type: Boolean,
|
|
160
|
+
value: false,
|
|
161
|
+
},
|
|
156
162
|
};
|
|
157
163
|
}
|
|
158
164
|
|
|
@@ -202,7 +208,13 @@ class GridSorter extends ThemableMixin(DirMixin(PolymerElement)) {
|
|
|
202
208
|
return;
|
|
203
209
|
}
|
|
204
210
|
|
|
205
|
-
this.dispatchEvent(
|
|
211
|
+
this.dispatchEvent(
|
|
212
|
+
new CustomEvent('sorter-changed', {
|
|
213
|
+
detail: { shiftClick: this._shiftClick },
|
|
214
|
+
bubbles: true,
|
|
215
|
+
composed: true,
|
|
216
|
+
}),
|
|
217
|
+
);
|
|
206
218
|
}
|
|
207
219
|
|
|
208
220
|
/** @private */
|
|
@@ -219,6 +231,7 @@ class GridSorter extends ThemableMixin(DirMixin(PolymerElement)) {
|
|
|
219
231
|
}
|
|
220
232
|
|
|
221
233
|
e.preventDefault();
|
|
234
|
+
this._shiftClick = e.shiftKey;
|
|
222
235
|
if (this.direction === 'asc') {
|
|
223
236
|
this.direction = 'desc';
|
|
224
237
|
} else if (this.direction === 'desc') {
|
|
@@ -24,13 +24,6 @@ declare class GridTreeColumn<TItem = GridDefaultItem> extends GridColumn<TItem>
|
|
|
24
24
|
* JS Path of the property in the item used as text content for the tree toggle.
|
|
25
25
|
*/
|
|
26
26
|
path: string | null | undefined;
|
|
27
|
-
|
|
28
|
-
/**
|
|
29
|
-
* JS Path of the property in the item that indicates whether the item has child items.
|
|
30
|
-
* @attr {string} item-has-children-path
|
|
31
|
-
* @deprecated Use `grid.itemHasChildrenPath` instead.
|
|
32
|
-
*/
|
|
33
|
-
itemHasChildrenPath: string | null | undefined;
|
|
34
27
|
}
|
|
35
28
|
|
|
36
29
|
declare global {
|
|
@@ -30,21 +30,11 @@ class GridTreeColumn extends GridColumn {
|
|
|
30
30
|
* JS Path of the property in the item used as text content for the tree toggle.
|
|
31
31
|
*/
|
|
32
32
|
path: String,
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* JS Path of the property in the item that indicates whether the item has child items.
|
|
36
|
-
* @attr {string} item-has-children-path
|
|
37
|
-
* @deprecated Use `grid.itemHasChildrenPath` instead.
|
|
38
|
-
*/
|
|
39
|
-
itemHasChildrenPath: {
|
|
40
|
-
type: String,
|
|
41
|
-
observer: '_itemHasChildrenPathChanged',
|
|
42
|
-
},
|
|
43
33
|
};
|
|
44
34
|
}
|
|
45
35
|
|
|
46
36
|
static get observers() {
|
|
47
|
-
return ['_onRendererOrBindingChanged(_renderer, _cells, _cells.*, path
|
|
37
|
+
return ['_onRendererOrBindingChanged(_renderer, _cells, _cells.*, path)'];
|
|
48
38
|
}
|
|
49
39
|
|
|
50
40
|
constructor() {
|
|
@@ -85,19 +75,6 @@ class GridTreeColumn extends GridColumn {
|
|
|
85
75
|
return this.__defaultRenderer;
|
|
86
76
|
}
|
|
87
77
|
|
|
88
|
-
/** @private */
|
|
89
|
-
_itemHasChildrenPathChanged(itemHasChildrenPath) {
|
|
90
|
-
if (itemHasChildrenPath) {
|
|
91
|
-
console.warn(
|
|
92
|
-
`WARNING: Since Vaadin 23, itemHasChildrenPath on <vaadin-grid-tree-column> is deprecated. Please set this property on the <vaadin-grid> instead.`,
|
|
93
|
-
);
|
|
94
|
-
|
|
95
|
-
if (this._grid) {
|
|
96
|
-
this._grid.itemHasChildrenPath = itemHasChildrenPath;
|
|
97
|
-
}
|
|
98
|
-
}
|
|
99
|
-
}
|
|
100
|
-
|
|
101
78
|
/**
|
|
102
79
|
* Expands or collapses the row once the tree toggle is switched.
|
|
103
80
|
* The listener handles only user-fired events.
|
package/src/vaadin-grid.d.ts
CHANGED
|
@@ -367,17 +367,6 @@ declare class Grid<TItem = GridDefaultItem> extends HTMLElement {
|
|
|
367
367
|
*/
|
|
368
368
|
requestContentUpdate(): void;
|
|
369
369
|
|
|
370
|
-
/**
|
|
371
|
-
* Updates the computed metrics and positioning of internal grid parts
|
|
372
|
-
* (row/details cell positioning etc). Needs to be invoked whenever the sizing of grid
|
|
373
|
-
* content changes asynchronously to ensure consistent appearance (e.g. when a
|
|
374
|
-
* contained image whose bounds aren't known beforehand finishes loading).
|
|
375
|
-
*
|
|
376
|
-
* @deprecated Since Vaadin 22, `notifyResize()` is deprecated. The component uses a
|
|
377
|
-
* ResizeObserver internally and doesn't need to be explicitly notified of resizes.
|
|
378
|
-
*/
|
|
379
|
-
notifyResize(): void;
|
|
380
|
-
|
|
381
370
|
addEventListener<K extends keyof GridEventMap<TItem>>(
|
|
382
371
|
type: K,
|
|
383
372
|
listener: (this: Grid<TItem>, ev: GridEventMap<TItem>[K]) => void,
|
package/src/vaadin-grid.js
CHANGED
|
@@ -1088,21 +1088,6 @@ class Grid extends ElementMixin(
|
|
|
1088
1088
|
this.__virtualizer.update(start, end);
|
|
1089
1089
|
}
|
|
1090
1090
|
}
|
|
1091
|
-
|
|
1092
|
-
/**
|
|
1093
|
-
* Updates the computed metrics and positioning of internal grid parts
|
|
1094
|
-
* (row/details cell positioning etc). Needs to be invoked whenever the sizing of grid
|
|
1095
|
-
* content changes asynchronously to ensure consistent appearance (e.g. when a
|
|
1096
|
-
* contained image whose bounds aren't known beforehand finishes loading).
|
|
1097
|
-
*
|
|
1098
|
-
* @deprecated Since Vaadin 22, `notifyResize()` is deprecated. The component uses a
|
|
1099
|
-
* ResizeObserver internally and doesn't need to be explicitly notified of resizes.
|
|
1100
|
-
*/
|
|
1101
|
-
notifyResize() {
|
|
1102
|
-
console.warn(
|
|
1103
|
-
`WARNING: Since Vaadin 22, notifyResize() is deprecated. The component uses a ResizeObserver internally and doesn't need to be explicitly notified of resizes.`,
|
|
1104
|
-
);
|
|
1105
|
-
}
|
|
1106
1091
|
}
|
|
1107
1092
|
|
|
1108
1093
|
customElements.define(Grid.is, Grid);
|
package/web-types.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid",
|
|
4
|
-
"version": "24.0.0-
|
|
4
|
+
"version": "24.0.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "vaadin-grid-column",
|
|
11
|
-
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
11
|
+
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
|
|
12
12
|
"attributes": [
|
|
13
13
|
{
|
|
14
14
|
"name": "resizable",
|
|
@@ -765,7 +765,7 @@
|
|
|
765
765
|
},
|
|
766
766
|
{
|
|
767
767
|
"name": "vaadin-grid-selection-column",
|
|
768
|
-
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
768
|
+
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-items),\nthe column header gets an additional checkbox that can be used for toggling\nselection for all the items at once.\n\n__The default content can also be overridden__",
|
|
769
769
|
"attributes": [
|
|
770
770
|
{
|
|
771
771
|
"name": "resizable",
|
|
@@ -1603,17 +1603,6 @@
|
|
|
1603
1603
|
]
|
|
1604
1604
|
}
|
|
1605
1605
|
},
|
|
1606
|
-
{
|
|
1607
|
-
"name": "item-has-children-path",
|
|
1608
|
-
"description": "JS Path of the property in the item that indicates whether the item has child items.",
|
|
1609
|
-
"value": {
|
|
1610
|
-
"type": [
|
|
1611
|
-
"string",
|
|
1612
|
-
"null",
|
|
1613
|
-
"undefined"
|
|
1614
|
-
]
|
|
1615
|
-
}
|
|
1616
|
-
},
|
|
1617
1606
|
{
|
|
1618
1607
|
"name": "theme",
|
|
1619
1608
|
"description": "The theme variants to apply to the component.",
|
|
@@ -1762,17 +1751,6 @@
|
|
|
1762
1751
|
"boolean"
|
|
1763
1752
|
]
|
|
1764
1753
|
}
|
|
1765
|
-
},
|
|
1766
|
-
{
|
|
1767
|
-
"name": "itemHasChildrenPath",
|
|
1768
|
-
"description": "JS Path of the property in the item that indicates whether the item has child items.",
|
|
1769
|
-
"value": {
|
|
1770
|
-
"type": [
|
|
1771
|
-
"string",
|
|
1772
|
-
"null",
|
|
1773
|
-
"undefined"
|
|
1774
|
-
]
|
|
1775
|
-
}
|
|
1776
1754
|
}
|
|
1777
1755
|
],
|
|
1778
1756
|
"events": []
|
|
@@ -1780,7 +1758,7 @@
|
|
|
1780
1758
|
},
|
|
1781
1759
|
{
|
|
1782
1760
|
"name": "vaadin-grid",
|
|
1783
|
-
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
1761
|
+
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-dataProvider) in\nthe API reference below for the detailed data provider arguments description,\nand the “Assigning Data” page in the demos.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`row` | Row in the internal table\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n-------------|-------------|------------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`last-frozen` | Last frozen cell | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when drag of a row is starting. The value is a number when multiple rows are dragged | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
1784
1762
|
"attributes": [
|
|
1785
1763
|
{
|
|
1786
1764
|
"name": "size",
|
|
@@ -1842,6 +1820,15 @@
|
|
|
1842
1820
|
]
|
|
1843
1821
|
}
|
|
1844
1822
|
},
|
|
1823
|
+
{
|
|
1824
|
+
"name": "multi-sort-on-shift-click",
|
|
1825
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
1826
|
+
"value": {
|
|
1827
|
+
"type": [
|
|
1828
|
+
"boolean"
|
|
1829
|
+
]
|
|
1830
|
+
}
|
|
1831
|
+
},
|
|
1845
1832
|
{
|
|
1846
1833
|
"name": "column-reordering-allowed",
|
|
1847
1834
|
"description": "Set to true to allow column reordering.",
|
|
@@ -2024,6 +2011,15 @@
|
|
|
2024
2011
|
]
|
|
2025
2012
|
}
|
|
2026
2013
|
},
|
|
2014
|
+
{
|
|
2015
|
+
"name": "multiSortOnShiftClick",
|
|
2016
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
2017
|
+
"value": {
|
|
2018
|
+
"type": [
|
|
2019
|
+
"boolean"
|
|
2020
|
+
]
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2027
2023
|
{
|
|
2028
2024
|
"name": "columnReorderingAllowed",
|
|
2029
2025
|
"description": "Set to true to allow column reordering.",
|
package/web-types.lit.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid",
|
|
4
|
-
"version": "24.0.0-
|
|
4
|
+
"version": "24.0.0-alpha2",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"framework": "lit",
|
|
7
7
|
"framework-config": {
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"elements": [
|
|
17
17
|
{
|
|
18
18
|
"name": "vaadin-grid-column",
|
|
19
|
-
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
19
|
+
"description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
|
|
20
20
|
"extension": true,
|
|
21
21
|
"attributes": [
|
|
22
22
|
{
|
|
@@ -303,7 +303,7 @@
|
|
|
303
303
|
},
|
|
304
304
|
{
|
|
305
305
|
"name": "vaadin-grid-selection-column",
|
|
306
|
-
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
306
|
+
"description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-items),\nthe column header gets an additional checkbox that can be used for toggling\nselection for all the items at once.\n\n__The default content can also be overridden__",
|
|
307
307
|
"extension": true,
|
|
308
308
|
"attributes": [
|
|
309
309
|
{
|
|
@@ -690,19 +690,12 @@
|
|
|
690
690
|
"value": {
|
|
691
691
|
"kind": "expression"
|
|
692
692
|
}
|
|
693
|
-
},
|
|
694
|
-
{
|
|
695
|
-
"name": ".itemHasChildrenPath",
|
|
696
|
-
"description": "JS Path of the property in the item that indicates whether the item has child items.",
|
|
697
|
-
"value": {
|
|
698
|
-
"kind": "expression"
|
|
699
|
-
}
|
|
700
693
|
}
|
|
701
694
|
]
|
|
702
695
|
},
|
|
703
696
|
{
|
|
704
697
|
"name": "vaadin-grid",
|
|
705
|
-
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-
|
|
698
|
+
"description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.0.0-alpha2/#/elements/vaadin-grid#property-dataProvider) in\nthe API reference below for the detailed data provider arguments description,\nand the “Assigning Data” page in the demos.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`row` | Row in the internal table\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n-------------|-------------|------------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`last-frozen` | Last frozen cell | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when drag of a row is starting. The value is a number when multiple rows are dragged | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/custom-theme/styling-components) documentation.",
|
|
706
699
|
"extension": true,
|
|
707
700
|
"attributes": [
|
|
708
701
|
{
|
|
@@ -712,6 +705,13 @@
|
|
|
712
705
|
"kind": "expression"
|
|
713
706
|
}
|
|
714
707
|
},
|
|
708
|
+
{
|
|
709
|
+
"name": "?multiSortOnShiftClick",
|
|
710
|
+
"description": "When `true`, Shift-clicking an unsorted column's sorter adds it to the multi-sort.\nShift + Space does the same action via keyboard. This property has precedence over the\n`multiSort` property. If `multiSortOnShiftClick` is true, the multiSort property is effectively ignored.",
|
|
711
|
+
"value": {
|
|
712
|
+
"kind": "expression"
|
|
713
|
+
}
|
|
714
|
+
},
|
|
715
715
|
{
|
|
716
716
|
"name": "?columnReorderingAllowed",
|
|
717
717
|
"description": "Set to true to allow column reordering.",
|