@vaadin/grid 25.2.0-alpha9 → 25.2.0-beta1
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/custom-elements.json +53 -19
- package/package.json +12 -12
- package/src/styles/vaadin-grid-filter-base-styles.js +4 -0
- package/src/styles/vaadin-grid-sorter-base-styles.js +4 -0
- package/src/styles/vaadin-grid-tree-toggle-base-styles.js +4 -0
- package/src/vaadin-grid-a11y-mixin.js +2 -5
- package/src/vaadin-grid-active-item-mixin.js +0 -15
- package/src/vaadin-grid-array-data-provider-mixin.js +0 -3
- package/src/vaadin-grid-column-auto-width-mixin.js +1 -4
- package/src/vaadin-grid-column-group-mixin.js +0 -3
- package/src/vaadin-grid-column-group.d.ts +3 -1
- package/src/vaadin-grid-column-group.js +0 -1
- package/src/vaadin-grid-column-mixin.js +2 -10
- package/src/vaadin-grid-column-reordering-mixin.js +3 -14
- package/src/vaadin-grid-column-resizing-mixin.js +0 -11
- package/src/vaadin-grid-column.d.ts +5 -2
- package/src/vaadin-grid-column.js +0 -1
- package/src/vaadin-grid-data-provider-mixin.js +0 -15
- package/src/vaadin-grid-drag-and-drop-mixin.js +1 -44
- package/src/vaadin-grid-dynamic-columns-mixin.js +1 -4
- package/src/vaadin-grid-event-context-mixin.js +0 -3
- package/src/vaadin-grid-filter-column-mixin.js +0 -3
- package/src/vaadin-grid-filter-column.d.ts +3 -1
- package/src/vaadin-grid-filter-column.js +0 -1
- package/src/vaadin-grid-filter-element-mixin.js +1 -3
- package/src/vaadin-grid-filter-mixin.js +0 -3
- package/src/vaadin-grid-filter.js +0 -1
- package/src/vaadin-grid-helpers.js +1 -1
- package/src/vaadin-grid-keyboard-navigation-mixin.js +2 -13
- package/src/vaadin-grid-mixin.js +4 -26
- package/src/vaadin-grid-resize-mixin.js +0 -2
- package/src/vaadin-grid-row-details-mixin.js +0 -3
- package/src/vaadin-grid-scroll-mixin.js +0 -3
- package/src/vaadin-grid-selection-column-base-mixin.js +0 -2
- package/src/vaadin-grid-selection-column-mixin.js +0 -4
- package/src/vaadin-grid-selection-column.d.ts +3 -1
- package/src/vaadin-grid-selection-column.js +0 -1
- package/src/vaadin-grid-selection-mixin.js +10 -20
- package/src/vaadin-grid-sort-column-mixin.js +0 -3
- package/src/vaadin-grid-sort-column.d.ts +3 -1
- package/src/vaadin-grid-sort-column.js +0 -1
- package/src/vaadin-grid-sort-mixin.js +0 -3
- package/src/vaadin-grid-sorter-mixin.js +0 -2
- package/src/vaadin-grid-sorter.js +0 -3
- package/src/vaadin-grid-styling-mixin.d.ts +1 -1
- package/src/vaadin-grid-styling-mixin.js +0 -3
- package/src/vaadin-grid-tree-column-mixin.js +0 -3
- package/src/vaadin-grid-tree-column.d.ts +3 -1
- package/src/vaadin-grid-tree-column.js +0 -1
- package/src/vaadin-grid-tree-toggle-mixin.js +0 -3
- package/src/vaadin-grid-tree-toggle.js +0 -3
- package/src/vaadin-grid.d.ts +1 -1
- package/src/vaadin-grid.js +1 -3
- package/web-types.json +397 -769
- package/web-types.lit.json +247 -233
package/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json.schemastore.org/web-types",
|
|
3
3
|
"name": "@vaadin/grid",
|
|
4
|
-
"version": "25.2.0-
|
|
4
|
+
"version": "25.2.0-beta1",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -15,9 +15,7 @@
|
|
|
15
15
|
"description": "Custom part name for the footer cell.",
|
|
16
16
|
"value": {
|
|
17
17
|
"type": [
|
|
18
|
-
"string"
|
|
19
|
-
"null",
|
|
20
|
-
"undefined"
|
|
18
|
+
"string"
|
|
21
19
|
]
|
|
22
20
|
}
|
|
23
21
|
},
|
|
@@ -26,9 +24,7 @@
|
|
|
26
24
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
27
25
|
"value": {
|
|
28
26
|
"type": [
|
|
29
|
-
"boolean"
|
|
30
|
-
"null",
|
|
31
|
-
"undefined"
|
|
27
|
+
"boolean"
|
|
32
28
|
]
|
|
33
29
|
}
|
|
34
30
|
},
|
|
@@ -37,9 +33,7 @@
|
|
|
37
33
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
38
34
|
"value": {
|
|
39
35
|
"type": [
|
|
40
|
-
"boolean"
|
|
41
|
-
"null",
|
|
42
|
-
"undefined"
|
|
36
|
+
"boolean"
|
|
43
37
|
]
|
|
44
38
|
}
|
|
45
39
|
},
|
|
@@ -48,9 +42,7 @@
|
|
|
48
42
|
"description": "Text content to display in the header cell of the column.",
|
|
49
43
|
"value": {
|
|
50
44
|
"type": [
|
|
51
|
-
"string"
|
|
52
|
-
"null",
|
|
53
|
-
"undefined"
|
|
45
|
+
"string"
|
|
54
46
|
]
|
|
55
47
|
}
|
|
56
48
|
},
|
|
@@ -59,9 +51,7 @@
|
|
|
59
51
|
"description": "Custom part name for the header cell.",
|
|
60
52
|
"value": {
|
|
61
53
|
"type": [
|
|
62
|
-
"string"
|
|
63
|
-
"null",
|
|
64
|
-
"undefined"
|
|
54
|
+
"string"
|
|
65
55
|
]
|
|
66
56
|
}
|
|
67
57
|
},
|
|
@@ -70,9 +60,7 @@
|
|
|
70
60
|
"description": "When set to true, the cells for this column are hidden.",
|
|
71
61
|
"value": {
|
|
72
62
|
"type": [
|
|
73
|
-
"boolean"
|
|
74
|
-
"null",
|
|
75
|
-
"undefined"
|
|
63
|
+
"boolean"
|
|
76
64
|
]
|
|
77
65
|
}
|
|
78
66
|
},
|
|
@@ -81,9 +69,7 @@
|
|
|
81
69
|
"description": "When set to true, the column is user-resizable.",
|
|
82
70
|
"value": {
|
|
83
71
|
"type": [
|
|
84
|
-
"boolean"
|
|
85
|
-
"null",
|
|
86
|
-
"undefined"
|
|
72
|
+
"boolean"
|
|
87
73
|
]
|
|
88
74
|
}
|
|
89
75
|
},
|
|
@@ -92,9 +78,7 @@
|
|
|
92
78
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
93
79
|
"value": {
|
|
94
80
|
"type": [
|
|
95
|
-
"boolean"
|
|
96
|
-
"null",
|
|
97
|
-
"undefined"
|
|
81
|
+
"boolean"
|
|
98
82
|
]
|
|
99
83
|
}
|
|
100
84
|
},
|
|
@@ -103,9 +87,7 @@
|
|
|
103
87
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
104
88
|
"value": {
|
|
105
89
|
"type": [
|
|
106
|
-
"string"
|
|
107
|
-
"null",
|
|
108
|
-
"undefined"
|
|
90
|
+
"string"
|
|
109
91
|
]
|
|
110
92
|
}
|
|
111
93
|
},
|
|
@@ -128,9 +110,7 @@
|
|
|
128
110
|
"description": "Custom part name for the footer cell.",
|
|
129
111
|
"value": {
|
|
130
112
|
"type": [
|
|
131
|
-
"string"
|
|
132
|
-
"null",
|
|
133
|
-
"undefined"
|
|
113
|
+
"string"
|
|
134
114
|
]
|
|
135
115
|
}
|
|
136
116
|
},
|
|
@@ -150,9 +130,7 @@
|
|
|
150
130
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
151
131
|
"value": {
|
|
152
132
|
"type": [
|
|
153
|
-
"boolean"
|
|
154
|
-
"null",
|
|
155
|
-
"undefined"
|
|
133
|
+
"boolean"
|
|
156
134
|
]
|
|
157
135
|
}
|
|
158
136
|
},
|
|
@@ -161,9 +139,7 @@
|
|
|
161
139
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
162
140
|
"value": {
|
|
163
141
|
"type": [
|
|
164
|
-
"boolean"
|
|
165
|
-
"null",
|
|
166
|
-
"undefined"
|
|
142
|
+
"boolean"
|
|
167
143
|
]
|
|
168
144
|
}
|
|
169
145
|
},
|
|
@@ -172,9 +148,7 @@
|
|
|
172
148
|
"description": "Text content to display in the header cell of the column.",
|
|
173
149
|
"value": {
|
|
174
150
|
"type": [
|
|
175
|
-
"string"
|
|
176
|
-
"null",
|
|
177
|
-
"undefined"
|
|
151
|
+
"string"
|
|
178
152
|
]
|
|
179
153
|
}
|
|
180
154
|
},
|
|
@@ -183,9 +157,7 @@
|
|
|
183
157
|
"description": "Custom part name for the header cell.",
|
|
184
158
|
"value": {
|
|
185
159
|
"type": [
|
|
186
|
-
"string"
|
|
187
|
-
"null",
|
|
188
|
-
"undefined"
|
|
160
|
+
"string"
|
|
189
161
|
]
|
|
190
162
|
}
|
|
191
163
|
},
|
|
@@ -205,9 +177,7 @@
|
|
|
205
177
|
"description": "When set to true, the cells for this column are hidden.",
|
|
206
178
|
"value": {
|
|
207
179
|
"type": [
|
|
208
|
-
"boolean"
|
|
209
|
-
"null",
|
|
210
|
-
"undefined"
|
|
180
|
+
"boolean"
|
|
211
181
|
]
|
|
212
182
|
}
|
|
213
183
|
},
|
|
@@ -216,9 +186,7 @@
|
|
|
216
186
|
"description": "When set to true, the column is user-resizable.",
|
|
217
187
|
"value": {
|
|
218
188
|
"type": [
|
|
219
|
-
"boolean"
|
|
220
|
-
"null",
|
|
221
|
-
"undefined"
|
|
189
|
+
"boolean"
|
|
222
190
|
]
|
|
223
191
|
}
|
|
224
192
|
},
|
|
@@ -227,9 +195,7 @@
|
|
|
227
195
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
228
196
|
"value": {
|
|
229
197
|
"type": [
|
|
230
|
-
"boolean"
|
|
231
|
-
"null",
|
|
232
|
-
"undefined"
|
|
198
|
+
"boolean"
|
|
233
199
|
]
|
|
234
200
|
}
|
|
235
201
|
},
|
|
@@ -238,9 +204,7 @@
|
|
|
238
204
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
239
205
|
"value": {
|
|
240
206
|
"type": [
|
|
241
|
-
"string"
|
|
242
|
-
"null",
|
|
243
|
-
"undefined"
|
|
207
|
+
"string"
|
|
244
208
|
]
|
|
245
209
|
}
|
|
246
210
|
}
|
|
@@ -250,16 +214,14 @@
|
|
|
250
214
|
},
|
|
251
215
|
{
|
|
252
216
|
"name": "vaadin-grid-column",
|
|
253
|
-
"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/25.2.0-
|
|
217
|
+
"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/25.2.0-beta1/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
|
|
254
218
|
"attributes": [
|
|
255
219
|
{
|
|
256
220
|
"name": "auto-width",
|
|
257
221
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
258
222
|
"value": {
|
|
259
223
|
"type": [
|
|
260
|
-
"boolean"
|
|
261
|
-
"null",
|
|
262
|
-
"undefined"
|
|
224
|
+
"boolean"
|
|
263
225
|
]
|
|
264
226
|
}
|
|
265
227
|
},
|
|
@@ -268,9 +230,7 @@
|
|
|
268
230
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
269
231
|
"value": {
|
|
270
232
|
"type": [
|
|
271
|
-
"number"
|
|
272
|
-
"null",
|
|
273
|
-
"undefined"
|
|
233
|
+
"number"
|
|
274
234
|
]
|
|
275
235
|
}
|
|
276
236
|
},
|
|
@@ -279,9 +239,7 @@
|
|
|
279
239
|
"description": "Custom part name for the footer cell.",
|
|
280
240
|
"value": {
|
|
281
241
|
"type": [
|
|
282
|
-
"string"
|
|
283
|
-
"null",
|
|
284
|
-
"undefined"
|
|
242
|
+
"string"
|
|
285
243
|
]
|
|
286
244
|
}
|
|
287
245
|
},
|
|
@@ -290,9 +248,7 @@
|
|
|
290
248
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
291
249
|
"value": {
|
|
292
250
|
"type": [
|
|
293
|
-
"boolean"
|
|
294
|
-
"null",
|
|
295
|
-
"undefined"
|
|
251
|
+
"boolean"
|
|
296
252
|
]
|
|
297
253
|
}
|
|
298
254
|
},
|
|
@@ -301,9 +257,7 @@
|
|
|
301
257
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
302
258
|
"value": {
|
|
303
259
|
"type": [
|
|
304
|
-
"boolean"
|
|
305
|
-
"null",
|
|
306
|
-
"undefined"
|
|
260
|
+
"boolean"
|
|
307
261
|
]
|
|
308
262
|
}
|
|
309
263
|
},
|
|
@@ -312,9 +266,7 @@
|
|
|
312
266
|
"description": "Text content to display in the header cell of the column.",
|
|
313
267
|
"value": {
|
|
314
268
|
"type": [
|
|
315
|
-
"string"
|
|
316
|
-
"null",
|
|
317
|
-
"undefined"
|
|
269
|
+
"string"
|
|
318
270
|
]
|
|
319
271
|
}
|
|
320
272
|
},
|
|
@@ -323,9 +275,7 @@
|
|
|
323
275
|
"description": "Custom part name for the header cell.",
|
|
324
276
|
"value": {
|
|
325
277
|
"type": [
|
|
326
|
-
"string"
|
|
327
|
-
"null",
|
|
328
|
-
"undefined"
|
|
278
|
+
"string"
|
|
329
279
|
]
|
|
330
280
|
}
|
|
331
281
|
},
|
|
@@ -334,9 +284,7 @@
|
|
|
334
284
|
"description": "When set to true, the cells for this column are hidden.",
|
|
335
285
|
"value": {
|
|
336
286
|
"type": [
|
|
337
|
-
"boolean"
|
|
338
|
-
"null",
|
|
339
|
-
"undefined"
|
|
287
|
+
"boolean"
|
|
340
288
|
]
|
|
341
289
|
}
|
|
342
290
|
},
|
|
@@ -345,9 +293,7 @@
|
|
|
345
293
|
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
346
294
|
"value": {
|
|
347
295
|
"type": [
|
|
348
|
-
"string"
|
|
349
|
-
"null",
|
|
350
|
-
"undefined"
|
|
296
|
+
"string"
|
|
351
297
|
]
|
|
352
298
|
}
|
|
353
299
|
},
|
|
@@ -356,9 +302,7 @@
|
|
|
356
302
|
"description": "When set to true, the column is user-resizable.",
|
|
357
303
|
"value": {
|
|
358
304
|
"type": [
|
|
359
|
-
"boolean"
|
|
360
|
-
"null",
|
|
361
|
-
"undefined"
|
|
305
|
+
"boolean"
|
|
362
306
|
]
|
|
363
307
|
}
|
|
364
308
|
},
|
|
@@ -367,9 +311,7 @@
|
|
|
367
311
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
368
312
|
"value": {
|
|
369
313
|
"type": [
|
|
370
|
-
"boolean"
|
|
371
|
-
"null",
|
|
372
|
-
"undefined"
|
|
314
|
+
"boolean"
|
|
373
315
|
]
|
|
374
316
|
}
|
|
375
317
|
},
|
|
@@ -378,9 +320,7 @@
|
|
|
378
320
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
379
321
|
"value": {
|
|
380
322
|
"type": [
|
|
381
|
-
"string"
|
|
382
|
-
"null",
|
|
383
|
-
"undefined"
|
|
323
|
+
"string"
|
|
384
324
|
]
|
|
385
325
|
}
|
|
386
326
|
},
|
|
@@ -400,9 +340,7 @@
|
|
|
400
340
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
401
341
|
"value": {
|
|
402
342
|
"type": [
|
|
403
|
-
"string"
|
|
404
|
-
"null",
|
|
405
|
-
"undefined"
|
|
343
|
+
"string"
|
|
406
344
|
]
|
|
407
345
|
}
|
|
408
346
|
}
|
|
@@ -414,9 +352,7 @@
|
|
|
414
352
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
415
353
|
"value": {
|
|
416
354
|
"type": [
|
|
417
|
-
"boolean"
|
|
418
|
-
"null",
|
|
419
|
-
"undefined"
|
|
355
|
+
"boolean"
|
|
420
356
|
]
|
|
421
357
|
}
|
|
422
358
|
},
|
|
@@ -425,9 +361,7 @@
|
|
|
425
361
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
426
362
|
"value": {
|
|
427
363
|
"type": [
|
|
428
|
-
"number"
|
|
429
|
-
"null",
|
|
430
|
-
"undefined"
|
|
364
|
+
"number"
|
|
431
365
|
]
|
|
432
366
|
}
|
|
433
367
|
},
|
|
@@ -436,9 +370,7 @@
|
|
|
436
370
|
"description": "Custom part name for the footer cell.",
|
|
437
371
|
"value": {
|
|
438
372
|
"type": [
|
|
439
|
-
"string"
|
|
440
|
-
"null",
|
|
441
|
-
"undefined"
|
|
373
|
+
"string"
|
|
442
374
|
]
|
|
443
375
|
}
|
|
444
376
|
},
|
|
@@ -458,9 +390,7 @@
|
|
|
458
390
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
459
391
|
"value": {
|
|
460
392
|
"type": [
|
|
461
|
-
"boolean"
|
|
462
|
-
"null",
|
|
463
|
-
"undefined"
|
|
393
|
+
"boolean"
|
|
464
394
|
]
|
|
465
395
|
}
|
|
466
396
|
},
|
|
@@ -469,9 +399,7 @@
|
|
|
469
399
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
470
400
|
"value": {
|
|
471
401
|
"type": [
|
|
472
|
-
"boolean"
|
|
473
|
-
"null",
|
|
474
|
-
"undefined"
|
|
402
|
+
"boolean"
|
|
475
403
|
]
|
|
476
404
|
}
|
|
477
405
|
},
|
|
@@ -480,9 +408,7 @@
|
|
|
480
408
|
"description": "Text content to display in the header cell of the column.",
|
|
481
409
|
"value": {
|
|
482
410
|
"type": [
|
|
483
|
-
"string"
|
|
484
|
-
"null",
|
|
485
|
-
"undefined"
|
|
411
|
+
"string"
|
|
486
412
|
]
|
|
487
413
|
}
|
|
488
414
|
},
|
|
@@ -491,9 +417,7 @@
|
|
|
491
417
|
"description": "Custom part name for the header cell.",
|
|
492
418
|
"value": {
|
|
493
419
|
"type": [
|
|
494
|
-
"string"
|
|
495
|
-
"null",
|
|
496
|
-
"undefined"
|
|
420
|
+
"string"
|
|
497
421
|
]
|
|
498
422
|
}
|
|
499
423
|
},
|
|
@@ -513,9 +437,7 @@
|
|
|
513
437
|
"description": "When set to true, the cells for this column are hidden.",
|
|
514
438
|
"value": {
|
|
515
439
|
"type": [
|
|
516
|
-
"boolean"
|
|
517
|
-
"null",
|
|
518
|
-
"undefined"
|
|
440
|
+
"boolean"
|
|
519
441
|
]
|
|
520
442
|
}
|
|
521
443
|
},
|
|
@@ -524,9 +446,7 @@
|
|
|
524
446
|
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
525
447
|
"value": {
|
|
526
448
|
"type": [
|
|
527
|
-
"string"
|
|
528
|
-
"null",
|
|
529
|
-
"undefined"
|
|
449
|
+
"string"
|
|
530
450
|
]
|
|
531
451
|
}
|
|
532
452
|
},
|
|
@@ -546,9 +466,7 @@
|
|
|
546
466
|
"description": "When set to true, the column is user-resizable.",
|
|
547
467
|
"value": {
|
|
548
468
|
"type": [
|
|
549
|
-
"boolean"
|
|
550
|
-
"null",
|
|
551
|
-
"undefined"
|
|
469
|
+
"boolean"
|
|
552
470
|
]
|
|
553
471
|
}
|
|
554
472
|
},
|
|
@@ -557,9 +475,7 @@
|
|
|
557
475
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
558
476
|
"value": {
|
|
559
477
|
"type": [
|
|
560
|
-
"boolean"
|
|
561
|
-
"null",
|
|
562
|
-
"undefined"
|
|
478
|
+
"boolean"
|
|
563
479
|
]
|
|
564
480
|
}
|
|
565
481
|
},
|
|
@@ -568,9 +484,7 @@
|
|
|
568
484
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
569
485
|
"value": {
|
|
570
486
|
"type": [
|
|
571
|
-
"string"
|
|
572
|
-
"null",
|
|
573
|
-
"undefined"
|
|
487
|
+
"string"
|
|
574
488
|
]
|
|
575
489
|
}
|
|
576
490
|
},
|
|
@@ -579,9 +493,7 @@
|
|
|
579
493
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
580
494
|
"value": {
|
|
581
495
|
"type": [
|
|
582
|
-
"string"
|
|
583
|
-
"null",
|
|
584
|
-
"undefined"
|
|
496
|
+
"string"
|
|
585
497
|
]
|
|
586
498
|
}
|
|
587
499
|
}
|
|
@@ -589,77 +501,6 @@
|
|
|
589
501
|
"events": []
|
|
590
502
|
}
|
|
591
503
|
},
|
|
592
|
-
{
|
|
593
|
-
"name": "vaadin-grid-filter",
|
|
594
|
-
"description": "`<vaadin-grid-filter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,\nand handlers for filtering the grid data.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.headerRenderer = (root, column) => {\n let filter = root.firstElementChild;\n if (!filter) {\n filter = document.createElement('vaadin-grid-filter');\n root.appendChild(filter);\n }\n filter.path = 'name.first';\n};\ncolumn.renderer = (root, column, model) => {\n root.textContent = model.item.name.first;\n};\n```",
|
|
595
|
-
"attributes": [
|
|
596
|
-
{
|
|
597
|
-
"name": "path",
|
|
598
|
-
"description": "JS Path of the property in the item used for filtering the data.",
|
|
599
|
-
"value": {
|
|
600
|
-
"type": [
|
|
601
|
-
"string",
|
|
602
|
-
"null",
|
|
603
|
-
"undefined"
|
|
604
|
-
]
|
|
605
|
-
}
|
|
606
|
-
},
|
|
607
|
-
{
|
|
608
|
-
"name": "theme",
|
|
609
|
-
"description": "The theme variants to apply to the component.",
|
|
610
|
-
"value": {
|
|
611
|
-
"type": [
|
|
612
|
-
"string",
|
|
613
|
-
"null",
|
|
614
|
-
"undefined"
|
|
615
|
-
]
|
|
616
|
-
}
|
|
617
|
-
},
|
|
618
|
-
{
|
|
619
|
-
"name": "value",
|
|
620
|
-
"description": "Current filter value.",
|
|
621
|
-
"value": {
|
|
622
|
-
"type": [
|
|
623
|
-
"string",
|
|
624
|
-
"null",
|
|
625
|
-
"undefined"
|
|
626
|
-
]
|
|
627
|
-
}
|
|
628
|
-
}
|
|
629
|
-
],
|
|
630
|
-
"js": {
|
|
631
|
-
"properties": [
|
|
632
|
-
{
|
|
633
|
-
"name": "path",
|
|
634
|
-
"description": "JS Path of the property in the item used for filtering the data.",
|
|
635
|
-
"value": {
|
|
636
|
-
"type": [
|
|
637
|
-
"string",
|
|
638
|
-
"null",
|
|
639
|
-
"undefined"
|
|
640
|
-
]
|
|
641
|
-
}
|
|
642
|
-
},
|
|
643
|
-
{
|
|
644
|
-
"name": "value",
|
|
645
|
-
"description": "Current filter value.",
|
|
646
|
-
"value": {
|
|
647
|
-
"type": [
|
|
648
|
-
"string",
|
|
649
|
-
"null",
|
|
650
|
-
"undefined"
|
|
651
|
-
]
|
|
652
|
-
}
|
|
653
|
-
}
|
|
654
|
-
],
|
|
655
|
-
"events": [
|
|
656
|
-
{
|
|
657
|
-
"name": "value-changed",
|
|
658
|
-
"description": "Fired when the `value` property changes."
|
|
659
|
-
}
|
|
660
|
-
]
|
|
661
|
-
}
|
|
662
|
-
},
|
|
663
504
|
{
|
|
664
505
|
"name": "vaadin-grid-filter-column",
|
|
665
506
|
"description": "`<vaadin-grid-filter-column>` is a helper element for the `<vaadin-grid>`\nthat provides default header renderer and functionality for filtering.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-filter-column path=\"name.first\"></vaadin-grid-filter-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
@@ -669,9 +510,7 @@
|
|
|
669
510
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
670
511
|
"value": {
|
|
671
512
|
"type": [
|
|
672
|
-
"boolean"
|
|
673
|
-
"null",
|
|
674
|
-
"undefined"
|
|
513
|
+
"boolean"
|
|
675
514
|
]
|
|
676
515
|
}
|
|
677
516
|
},
|
|
@@ -680,9 +519,7 @@
|
|
|
680
519
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
681
520
|
"value": {
|
|
682
521
|
"type": [
|
|
683
|
-
"number"
|
|
684
|
-
"null",
|
|
685
|
-
"undefined"
|
|
522
|
+
"number"
|
|
686
523
|
]
|
|
687
524
|
}
|
|
688
525
|
},
|
|
@@ -691,9 +528,7 @@
|
|
|
691
528
|
"description": "Custom part name for the footer cell.",
|
|
692
529
|
"value": {
|
|
693
530
|
"type": [
|
|
694
|
-
"string"
|
|
695
|
-
"null",
|
|
696
|
-
"undefined"
|
|
531
|
+
"string"
|
|
697
532
|
]
|
|
698
533
|
}
|
|
699
534
|
},
|
|
@@ -702,9 +537,7 @@
|
|
|
702
537
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
703
538
|
"value": {
|
|
704
539
|
"type": [
|
|
705
|
-
"boolean"
|
|
706
|
-
"null",
|
|
707
|
-
"undefined"
|
|
540
|
+
"boolean"
|
|
708
541
|
]
|
|
709
542
|
}
|
|
710
543
|
},
|
|
@@ -713,9 +546,7 @@
|
|
|
713
546
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
714
547
|
"value": {
|
|
715
548
|
"type": [
|
|
716
|
-
"boolean"
|
|
717
|
-
"null",
|
|
718
|
-
"undefined"
|
|
549
|
+
"boolean"
|
|
719
550
|
]
|
|
720
551
|
}
|
|
721
552
|
},
|
|
@@ -724,9 +555,7 @@
|
|
|
724
555
|
"description": "Text to display as the label of the column filter text-field.",
|
|
725
556
|
"value": {
|
|
726
557
|
"type": [
|
|
727
|
-
"string"
|
|
728
|
-
"null",
|
|
729
|
-
"undefined"
|
|
558
|
+
"string"
|
|
730
559
|
]
|
|
731
560
|
}
|
|
732
561
|
},
|
|
@@ -735,9 +564,7 @@
|
|
|
735
564
|
"description": "Custom part name for the header cell.",
|
|
736
565
|
"value": {
|
|
737
566
|
"type": [
|
|
738
|
-
"string"
|
|
739
|
-
"null",
|
|
740
|
-
"undefined"
|
|
567
|
+
"string"
|
|
741
568
|
]
|
|
742
569
|
}
|
|
743
570
|
},
|
|
@@ -746,9 +573,7 @@
|
|
|
746
573
|
"description": "When set to true, the cells for this column are hidden.",
|
|
747
574
|
"value": {
|
|
748
575
|
"type": [
|
|
749
|
-
"boolean"
|
|
750
|
-
"null",
|
|
751
|
-
"undefined"
|
|
576
|
+
"boolean"
|
|
752
577
|
]
|
|
753
578
|
}
|
|
754
579
|
},
|
|
@@ -757,9 +582,7 @@
|
|
|
757
582
|
"description": "JS Path of the property in the item used for filtering the data.",
|
|
758
583
|
"value": {
|
|
759
584
|
"type": [
|
|
760
|
-
"string"
|
|
761
|
-
"null",
|
|
762
|
-
"undefined"
|
|
585
|
+
"string"
|
|
763
586
|
]
|
|
764
587
|
}
|
|
765
588
|
},
|
|
@@ -768,9 +591,7 @@
|
|
|
768
591
|
"description": "When set to true, the column is user-resizable.",
|
|
769
592
|
"value": {
|
|
770
593
|
"type": [
|
|
771
|
-
"boolean"
|
|
772
|
-
"null",
|
|
773
|
-
"undefined"
|
|
594
|
+
"boolean"
|
|
774
595
|
]
|
|
775
596
|
}
|
|
776
597
|
},
|
|
@@ -779,9 +600,7 @@
|
|
|
779
600
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
780
601
|
"value": {
|
|
781
602
|
"type": [
|
|
782
|
-
"boolean"
|
|
783
|
-
"null",
|
|
784
|
-
"undefined"
|
|
603
|
+
"boolean"
|
|
785
604
|
]
|
|
786
605
|
}
|
|
787
606
|
},
|
|
@@ -790,9 +609,7 @@
|
|
|
790
609
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
791
610
|
"value": {
|
|
792
611
|
"type": [
|
|
793
|
-
"string"
|
|
794
|
-
"null",
|
|
795
|
-
"undefined"
|
|
612
|
+
"string"
|
|
796
613
|
]
|
|
797
614
|
}
|
|
798
615
|
},
|
|
@@ -812,9 +629,7 @@
|
|
|
812
629
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
813
630
|
"value": {
|
|
814
631
|
"type": [
|
|
815
|
-
"string"
|
|
816
|
-
"null",
|
|
817
|
-
"undefined"
|
|
632
|
+
"string"
|
|
818
633
|
]
|
|
819
634
|
}
|
|
820
635
|
}
|
|
@@ -826,9 +641,7 @@
|
|
|
826
641
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
827
642
|
"value": {
|
|
828
643
|
"type": [
|
|
829
|
-
"boolean"
|
|
830
|
-
"null",
|
|
831
|
-
"undefined"
|
|
644
|
+
"boolean"
|
|
832
645
|
]
|
|
833
646
|
}
|
|
834
647
|
},
|
|
@@ -837,9 +650,7 @@
|
|
|
837
650
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
838
651
|
"value": {
|
|
839
652
|
"type": [
|
|
840
|
-
"number"
|
|
841
|
-
"null",
|
|
842
|
-
"undefined"
|
|
653
|
+
"number"
|
|
843
654
|
]
|
|
844
655
|
}
|
|
845
656
|
},
|
|
@@ -848,9 +659,7 @@
|
|
|
848
659
|
"description": "Custom part name for the footer cell.",
|
|
849
660
|
"value": {
|
|
850
661
|
"type": [
|
|
851
|
-
"string"
|
|
852
|
-
"null",
|
|
853
|
-
"undefined"
|
|
662
|
+
"string"
|
|
854
663
|
]
|
|
855
664
|
}
|
|
856
665
|
},
|
|
@@ -870,9 +679,7 @@
|
|
|
870
679
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
871
680
|
"value": {
|
|
872
681
|
"type": [
|
|
873
|
-
"boolean"
|
|
874
|
-
"null",
|
|
875
|
-
"undefined"
|
|
682
|
+
"boolean"
|
|
876
683
|
]
|
|
877
684
|
}
|
|
878
685
|
},
|
|
@@ -881,9 +688,7 @@
|
|
|
881
688
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
882
689
|
"value": {
|
|
883
690
|
"type": [
|
|
884
|
-
"boolean"
|
|
885
|
-
"null",
|
|
886
|
-
"undefined"
|
|
691
|
+
"boolean"
|
|
887
692
|
]
|
|
888
693
|
}
|
|
889
694
|
},
|
|
@@ -892,9 +697,7 @@
|
|
|
892
697
|
"description": "Text to display as the label of the column filter text-field.",
|
|
893
698
|
"value": {
|
|
894
699
|
"type": [
|
|
895
|
-
"string"
|
|
896
|
-
"null",
|
|
897
|
-
"undefined"
|
|
700
|
+
"string"
|
|
898
701
|
]
|
|
899
702
|
}
|
|
900
703
|
},
|
|
@@ -903,9 +706,7 @@
|
|
|
903
706
|
"description": "Custom part name for the header cell.",
|
|
904
707
|
"value": {
|
|
905
708
|
"type": [
|
|
906
|
-
"string"
|
|
907
|
-
"null",
|
|
908
|
-
"undefined"
|
|
709
|
+
"string"
|
|
909
710
|
]
|
|
910
711
|
}
|
|
911
712
|
},
|
|
@@ -925,9 +726,7 @@
|
|
|
925
726
|
"description": "When set to true, the cells for this column are hidden.",
|
|
926
727
|
"value": {
|
|
927
728
|
"type": [
|
|
928
|
-
"boolean"
|
|
929
|
-
"null",
|
|
930
|
-
"undefined"
|
|
729
|
+
"boolean"
|
|
931
730
|
]
|
|
932
731
|
}
|
|
933
732
|
},
|
|
@@ -936,9 +735,7 @@
|
|
|
936
735
|
"description": "JS Path of the property in the item used for filtering the data.",
|
|
937
736
|
"value": {
|
|
938
737
|
"type": [
|
|
939
|
-
"string"
|
|
940
|
-
"null",
|
|
941
|
-
"undefined"
|
|
738
|
+
"string"
|
|
942
739
|
]
|
|
943
740
|
}
|
|
944
741
|
},
|
|
@@ -958,9 +755,7 @@
|
|
|
958
755
|
"description": "When set to true, the column is user-resizable.",
|
|
959
756
|
"value": {
|
|
960
757
|
"type": [
|
|
961
|
-
"boolean"
|
|
962
|
-
"null",
|
|
963
|
-
"undefined"
|
|
758
|
+
"boolean"
|
|
964
759
|
]
|
|
965
760
|
}
|
|
966
761
|
},
|
|
@@ -969,9 +764,7 @@
|
|
|
969
764
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
970
765
|
"value": {
|
|
971
766
|
"type": [
|
|
972
|
-
"boolean"
|
|
973
|
-
"null",
|
|
974
|
-
"undefined"
|
|
767
|
+
"boolean"
|
|
975
768
|
]
|
|
976
769
|
}
|
|
977
770
|
},
|
|
@@ -980,9 +773,7 @@
|
|
|
980
773
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
981
774
|
"value": {
|
|
982
775
|
"type": [
|
|
983
|
-
"string"
|
|
984
|
-
"null",
|
|
985
|
-
"undefined"
|
|
776
|
+
"string"
|
|
986
777
|
]
|
|
987
778
|
}
|
|
988
779
|
},
|
|
@@ -991,9 +782,7 @@
|
|
|
991
782
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
992
783
|
"value": {
|
|
993
784
|
"type": [
|
|
994
|
-
"string"
|
|
995
|
-
"null",
|
|
996
|
-
"undefined"
|
|
785
|
+
"string"
|
|
997
786
|
]
|
|
998
787
|
}
|
|
999
788
|
}
|
|
@@ -1002,61 +791,114 @@
|
|
|
1002
791
|
}
|
|
1003
792
|
},
|
|
1004
793
|
{
|
|
1005
|
-
"name": "vaadin-grid-
|
|
1006
|
-
"description": "`<vaadin-grid-
|
|
794
|
+
"name": "vaadin-grid-filter",
|
|
795
|
+
"description": "`<vaadin-grid-filter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,\nand handlers for filtering the grid data.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.headerRenderer = (root, column) => {\n let filter = root.firstElementChild;\n if (!filter) {\n filter = document.createElement('vaadin-grid-filter');\n root.appendChild(filter);\n }\n filter.path = 'name.first';\n};\ncolumn.renderer = (root, column, model) => {\n root.textContent = model.item.name.first;\n};\n```",
|
|
1007
796
|
"attributes": [
|
|
1008
797
|
{
|
|
1009
|
-
"name": "
|
|
1010
|
-
"description": "
|
|
1011
|
-
"value": {
|
|
1012
|
-
"type": [
|
|
1013
|
-
"boolean",
|
|
1014
|
-
"null",
|
|
1015
|
-
"undefined"
|
|
1016
|
-
]
|
|
1017
|
-
}
|
|
1018
|
-
},
|
|
1019
|
-
{
|
|
1020
|
-
"name": "auto-width",
|
|
1021
|
-
"description": "Override `autoWidth` to enable auto-width",
|
|
798
|
+
"name": "path",
|
|
799
|
+
"description": "JS Path of the property in the item used for filtering the data.",
|
|
1022
800
|
"value": {
|
|
1023
801
|
"type": [
|
|
1024
|
-
"
|
|
1025
|
-
"null",
|
|
1026
|
-
"undefined"
|
|
802
|
+
"string"
|
|
1027
803
|
]
|
|
1028
804
|
}
|
|
1029
805
|
},
|
|
1030
806
|
{
|
|
1031
|
-
"name": "
|
|
1032
|
-
"description": "
|
|
807
|
+
"name": "theme",
|
|
808
|
+
"description": "The theme variants to apply to the component.",
|
|
1033
809
|
"value": {
|
|
1034
810
|
"type": [
|
|
1035
|
-
"
|
|
811
|
+
"string",
|
|
1036
812
|
"null",
|
|
1037
813
|
"undefined"
|
|
1038
814
|
]
|
|
1039
815
|
}
|
|
1040
816
|
},
|
|
1041
817
|
{
|
|
1042
|
-
"name": "
|
|
1043
|
-
"description": "
|
|
818
|
+
"name": "value",
|
|
819
|
+
"description": "Current filter value.",
|
|
1044
820
|
"value": {
|
|
1045
821
|
"type": [
|
|
1046
|
-
"
|
|
1047
|
-
"null",
|
|
1048
|
-
"undefined"
|
|
822
|
+
"string"
|
|
1049
823
|
]
|
|
1050
824
|
}
|
|
1051
|
-
}
|
|
825
|
+
}
|
|
826
|
+
],
|
|
827
|
+
"js": {
|
|
828
|
+
"properties": [
|
|
829
|
+
{
|
|
830
|
+
"name": "path",
|
|
831
|
+
"description": "JS Path of the property in the item used for filtering the data.",
|
|
832
|
+
"value": {
|
|
833
|
+
"type": [
|
|
834
|
+
"string"
|
|
835
|
+
]
|
|
836
|
+
}
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
"name": "value",
|
|
840
|
+
"description": "Current filter value.",
|
|
841
|
+
"value": {
|
|
842
|
+
"type": [
|
|
843
|
+
"string"
|
|
844
|
+
]
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
],
|
|
848
|
+
"events": [
|
|
849
|
+
{
|
|
850
|
+
"name": "value-changed",
|
|
851
|
+
"description": "Fired when the `value` property changes."
|
|
852
|
+
}
|
|
853
|
+
]
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
{
|
|
857
|
+
"name": "vaadin-grid-selection-column",
|
|
858
|
+
"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>\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/25.2.0-beta1/#/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__",
|
|
859
|
+
"attributes": [
|
|
860
|
+
{
|
|
861
|
+
"name": "auto-select",
|
|
862
|
+
"description": "When true, the active item gets automatically selected.",
|
|
863
|
+
"value": {
|
|
864
|
+
"type": [
|
|
865
|
+
"boolean"
|
|
866
|
+
]
|
|
867
|
+
}
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
"name": "auto-width",
|
|
871
|
+
"description": "Override `autoWidth` to enable auto-width",
|
|
872
|
+
"value": {
|
|
873
|
+
"type": [
|
|
874
|
+
"boolean"
|
|
875
|
+
]
|
|
876
|
+
}
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "drag-select",
|
|
880
|
+
"description": "When true, rows can be selected by dragging over the selection column.",
|
|
881
|
+
"value": {
|
|
882
|
+
"type": [
|
|
883
|
+
"boolean"
|
|
884
|
+
]
|
|
885
|
+
}
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"name": "flex-grow",
|
|
889
|
+
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
890
|
+
"value": {
|
|
891
|
+
"type": [
|
|
892
|
+
"number"
|
|
893
|
+
]
|
|
894
|
+
}
|
|
895
|
+
},
|
|
1052
896
|
{
|
|
1053
897
|
"name": "footer-part-name",
|
|
1054
898
|
"description": "Custom part name for the footer cell.",
|
|
1055
899
|
"value": {
|
|
1056
900
|
"type": [
|
|
1057
|
-
"string"
|
|
1058
|
-
"null",
|
|
1059
|
-
"undefined"
|
|
901
|
+
"string"
|
|
1060
902
|
]
|
|
1061
903
|
}
|
|
1062
904
|
},
|
|
@@ -1065,9 +907,7 @@
|
|
|
1065
907
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
1066
908
|
"value": {
|
|
1067
909
|
"type": [
|
|
1068
|
-
"boolean"
|
|
1069
|
-
"null",
|
|
1070
|
-
"undefined"
|
|
910
|
+
"boolean"
|
|
1071
911
|
]
|
|
1072
912
|
}
|
|
1073
913
|
},
|
|
@@ -1076,9 +916,7 @@
|
|
|
1076
916
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
1077
917
|
"value": {
|
|
1078
918
|
"type": [
|
|
1079
|
-
"boolean"
|
|
1080
|
-
"null",
|
|
1081
|
-
"undefined"
|
|
919
|
+
"boolean"
|
|
1082
920
|
]
|
|
1083
921
|
}
|
|
1084
922
|
},
|
|
@@ -1087,9 +925,7 @@
|
|
|
1087
925
|
"description": "Text content to display in the header cell of the column.",
|
|
1088
926
|
"value": {
|
|
1089
927
|
"type": [
|
|
1090
|
-
"string"
|
|
1091
|
-
"null",
|
|
1092
|
-
"undefined"
|
|
928
|
+
"string"
|
|
1093
929
|
]
|
|
1094
930
|
}
|
|
1095
931
|
},
|
|
@@ -1098,9 +934,7 @@
|
|
|
1098
934
|
"description": "Custom part name for the header cell.",
|
|
1099
935
|
"value": {
|
|
1100
936
|
"type": [
|
|
1101
|
-
"string"
|
|
1102
|
-
"null",
|
|
1103
|
-
"undefined"
|
|
937
|
+
"string"
|
|
1104
938
|
]
|
|
1105
939
|
}
|
|
1106
940
|
},
|
|
@@ -1109,9 +943,7 @@
|
|
|
1109
943
|
"description": "When set to true, the cells for this column are hidden.",
|
|
1110
944
|
"value": {
|
|
1111
945
|
"type": [
|
|
1112
|
-
"boolean"
|
|
1113
|
-
"null",
|
|
1114
|
-
"undefined"
|
|
946
|
+
"boolean"
|
|
1115
947
|
]
|
|
1116
948
|
}
|
|
1117
949
|
},
|
|
@@ -1120,9 +952,7 @@
|
|
|
1120
952
|
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
1121
953
|
"value": {
|
|
1122
954
|
"type": [
|
|
1123
|
-
"string"
|
|
1124
|
-
"null",
|
|
1125
|
-
"undefined"
|
|
955
|
+
"string"
|
|
1126
956
|
]
|
|
1127
957
|
}
|
|
1128
958
|
},
|
|
@@ -1131,9 +961,7 @@
|
|
|
1131
961
|
"description": "When set to true, the column is user-resizable.",
|
|
1132
962
|
"value": {
|
|
1133
963
|
"type": [
|
|
1134
|
-
"boolean"
|
|
1135
|
-
"null",
|
|
1136
|
-
"undefined"
|
|
964
|
+
"boolean"
|
|
1137
965
|
]
|
|
1138
966
|
}
|
|
1139
967
|
},
|
|
@@ -1142,9 +970,7 @@
|
|
|
1142
970
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
1143
971
|
"value": {
|
|
1144
972
|
"type": [
|
|
1145
|
-
"boolean"
|
|
1146
|
-
"null",
|
|
1147
|
-
"undefined"
|
|
973
|
+
"boolean"
|
|
1148
974
|
]
|
|
1149
975
|
}
|
|
1150
976
|
},
|
|
@@ -1153,9 +979,7 @@
|
|
|
1153
979
|
"description": "When true, all the items are selected.",
|
|
1154
980
|
"value": {
|
|
1155
981
|
"type": [
|
|
1156
|
-
"boolean"
|
|
1157
|
-
"null",
|
|
1158
|
-
"undefined"
|
|
982
|
+
"boolean"
|
|
1159
983
|
]
|
|
1160
984
|
}
|
|
1161
985
|
},
|
|
@@ -1164,9 +988,7 @@
|
|
|
1164
988
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
1165
989
|
"value": {
|
|
1166
990
|
"type": [
|
|
1167
|
-
"string"
|
|
1168
|
-
"null",
|
|
1169
|
-
"undefined"
|
|
991
|
+
"string"
|
|
1170
992
|
]
|
|
1171
993
|
}
|
|
1172
994
|
},
|
|
@@ -1186,9 +1008,7 @@
|
|
|
1186
1008
|
"description": "Width of the cells for this column.",
|
|
1187
1009
|
"value": {
|
|
1188
1010
|
"type": [
|
|
1189
|
-
"string"
|
|
1190
|
-
"null",
|
|
1191
|
-
"undefined"
|
|
1011
|
+
"string"
|
|
1192
1012
|
]
|
|
1193
1013
|
}
|
|
1194
1014
|
}
|
|
@@ -1200,9 +1020,7 @@
|
|
|
1200
1020
|
"description": "When true, the active item gets automatically selected.",
|
|
1201
1021
|
"value": {
|
|
1202
1022
|
"type": [
|
|
1203
|
-
"boolean"
|
|
1204
|
-
"null",
|
|
1205
|
-
"undefined"
|
|
1023
|
+
"boolean"
|
|
1206
1024
|
]
|
|
1207
1025
|
}
|
|
1208
1026
|
},
|
|
@@ -1211,9 +1029,7 @@
|
|
|
1211
1029
|
"description": "Override `autoWidth` to enable auto-width",
|
|
1212
1030
|
"value": {
|
|
1213
1031
|
"type": [
|
|
1214
|
-
"boolean"
|
|
1215
|
-
"null",
|
|
1216
|
-
"undefined"
|
|
1032
|
+
"boolean"
|
|
1217
1033
|
]
|
|
1218
1034
|
}
|
|
1219
1035
|
},
|
|
@@ -1222,9 +1038,7 @@
|
|
|
1222
1038
|
"description": "When true, rows can be selected by dragging over the selection column.",
|
|
1223
1039
|
"value": {
|
|
1224
1040
|
"type": [
|
|
1225
|
-
"boolean"
|
|
1226
|
-
"null",
|
|
1227
|
-
"undefined"
|
|
1041
|
+
"boolean"
|
|
1228
1042
|
]
|
|
1229
1043
|
}
|
|
1230
1044
|
},
|
|
@@ -1233,9 +1047,7 @@
|
|
|
1233
1047
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
1234
1048
|
"value": {
|
|
1235
1049
|
"type": [
|
|
1236
|
-
"number"
|
|
1237
|
-
"null",
|
|
1238
|
-
"undefined"
|
|
1050
|
+
"number"
|
|
1239
1051
|
]
|
|
1240
1052
|
}
|
|
1241
1053
|
},
|
|
@@ -1244,9 +1056,7 @@
|
|
|
1244
1056
|
"description": "Custom part name for the footer cell.",
|
|
1245
1057
|
"value": {
|
|
1246
1058
|
"type": [
|
|
1247
|
-
"string"
|
|
1248
|
-
"null",
|
|
1249
|
-
"undefined"
|
|
1059
|
+
"string"
|
|
1250
1060
|
]
|
|
1251
1061
|
}
|
|
1252
1062
|
},
|
|
@@ -1266,9 +1076,7 @@
|
|
|
1266
1076
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
1267
1077
|
"value": {
|
|
1268
1078
|
"type": [
|
|
1269
|
-
"boolean"
|
|
1270
|
-
"null",
|
|
1271
|
-
"undefined"
|
|
1079
|
+
"boolean"
|
|
1272
1080
|
]
|
|
1273
1081
|
}
|
|
1274
1082
|
},
|
|
@@ -1277,9 +1085,7 @@
|
|
|
1277
1085
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
1278
1086
|
"value": {
|
|
1279
1087
|
"type": [
|
|
1280
|
-
"boolean"
|
|
1281
|
-
"null",
|
|
1282
|
-
"undefined"
|
|
1088
|
+
"boolean"
|
|
1283
1089
|
]
|
|
1284
1090
|
}
|
|
1285
1091
|
},
|
|
@@ -1288,9 +1094,7 @@
|
|
|
1288
1094
|
"description": "Text content to display in the header cell of the column.",
|
|
1289
1095
|
"value": {
|
|
1290
1096
|
"type": [
|
|
1291
|
-
"string"
|
|
1292
|
-
"null",
|
|
1293
|
-
"undefined"
|
|
1097
|
+
"string"
|
|
1294
1098
|
]
|
|
1295
1099
|
}
|
|
1296
1100
|
},
|
|
@@ -1299,9 +1103,7 @@
|
|
|
1299
1103
|
"description": "Custom part name for the header cell.",
|
|
1300
1104
|
"value": {
|
|
1301
1105
|
"type": [
|
|
1302
|
-
"string"
|
|
1303
|
-
"null",
|
|
1304
|
-
"undefined"
|
|
1106
|
+
"string"
|
|
1305
1107
|
]
|
|
1306
1108
|
}
|
|
1307
1109
|
},
|
|
@@ -1321,9 +1123,7 @@
|
|
|
1321
1123
|
"description": "When set to true, the cells for this column are hidden.",
|
|
1322
1124
|
"value": {
|
|
1323
1125
|
"type": [
|
|
1324
|
-
"boolean"
|
|
1325
|
-
"null",
|
|
1326
|
-
"undefined"
|
|
1126
|
+
"boolean"
|
|
1327
1127
|
]
|
|
1328
1128
|
}
|
|
1329
1129
|
},
|
|
@@ -1332,9 +1132,7 @@
|
|
|
1332
1132
|
"description": "Path to an item sub-property whose value gets displayed in the column body cells.\nThe property name is also shown in the column header if an explicit header or renderer isn't defined.",
|
|
1333
1133
|
"value": {
|
|
1334
1134
|
"type": [
|
|
1335
|
-
"string"
|
|
1336
|
-
"null",
|
|
1337
|
-
"undefined"
|
|
1135
|
+
"string"
|
|
1338
1136
|
]
|
|
1339
1137
|
}
|
|
1340
1138
|
},
|
|
@@ -1354,9 +1152,7 @@
|
|
|
1354
1152
|
"description": "When set to true, the column is user-resizable.",
|
|
1355
1153
|
"value": {
|
|
1356
1154
|
"type": [
|
|
1357
|
-
"boolean"
|
|
1358
|
-
"null",
|
|
1359
|
-
"undefined"
|
|
1155
|
+
"boolean"
|
|
1360
1156
|
]
|
|
1361
1157
|
}
|
|
1362
1158
|
},
|
|
@@ -1365,9 +1161,7 @@
|
|
|
1365
1161
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
1366
1162
|
"value": {
|
|
1367
1163
|
"type": [
|
|
1368
|
-
"boolean"
|
|
1369
|
-
"null",
|
|
1370
|
-
"undefined"
|
|
1164
|
+
"boolean"
|
|
1371
1165
|
]
|
|
1372
1166
|
}
|
|
1373
1167
|
},
|
|
@@ -1376,9 +1170,7 @@
|
|
|
1376
1170
|
"description": "When true, all the items are selected.",
|
|
1377
1171
|
"value": {
|
|
1378
1172
|
"type": [
|
|
1379
|
-
"boolean"
|
|
1380
|
-
"null",
|
|
1381
|
-
"undefined"
|
|
1173
|
+
"boolean"
|
|
1382
1174
|
]
|
|
1383
1175
|
}
|
|
1384
1176
|
},
|
|
@@ -1387,9 +1179,7 @@
|
|
|
1387
1179
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
1388
1180
|
"value": {
|
|
1389
1181
|
"type": [
|
|
1390
|
-
"string"
|
|
1391
|
-
"null",
|
|
1392
|
-
"undefined"
|
|
1182
|
+
"string"
|
|
1393
1183
|
]
|
|
1394
1184
|
}
|
|
1395
1185
|
},
|
|
@@ -1398,9 +1188,7 @@
|
|
|
1398
1188
|
"description": "Width of the cells for this column.",
|
|
1399
1189
|
"value": {
|
|
1400
1190
|
"type": [
|
|
1401
|
-
"string"
|
|
1402
|
-
"null",
|
|
1403
|
-
"undefined"
|
|
1191
|
+
"string"
|
|
1404
1192
|
]
|
|
1405
1193
|
}
|
|
1406
1194
|
}
|
|
@@ -1413,77 +1201,6 @@
|
|
|
1413
1201
|
]
|
|
1414
1202
|
}
|
|
1415
1203
|
},
|
|
1416
|
-
{
|
|
1417
|
-
"name": "vaadin-grid-sorter",
|
|
1418
|
-
"description": "`<vaadin-grid-sorter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,\nvisual feedback, and handlers for sorting the grid data.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.renderer = (root, column, model) => {\n let sorter = root.firstElementChild;\n if (!sorter) {\n sorter = document.createElement('vaadin-grid-sorter');\n root.appendChild(sorter);\n }\n sorter.path = 'name.first';\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The slotted content wrapper\n`indicators` | The internal sorter indicators.\n`order` | The internal sorter order\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-------------|---------------------------\n`direction` | Sort direction of a sorter",
|
|
1419
|
-
"attributes": [
|
|
1420
|
-
{
|
|
1421
|
-
"name": "direction",
|
|
1422
|
-
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1423
|
-
"value": {
|
|
1424
|
-
"type": [
|
|
1425
|
-
"string",
|
|
1426
|
-
"null",
|
|
1427
|
-
"undefined"
|
|
1428
|
-
]
|
|
1429
|
-
}
|
|
1430
|
-
},
|
|
1431
|
-
{
|
|
1432
|
-
"name": "path",
|
|
1433
|
-
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1434
|
-
"value": {
|
|
1435
|
-
"type": [
|
|
1436
|
-
"string",
|
|
1437
|
-
"null",
|
|
1438
|
-
"undefined"
|
|
1439
|
-
]
|
|
1440
|
-
}
|
|
1441
|
-
},
|
|
1442
|
-
{
|
|
1443
|
-
"name": "theme",
|
|
1444
|
-
"description": "The theme variants to apply to the component.",
|
|
1445
|
-
"value": {
|
|
1446
|
-
"type": [
|
|
1447
|
-
"string",
|
|
1448
|
-
"null",
|
|
1449
|
-
"undefined"
|
|
1450
|
-
]
|
|
1451
|
-
}
|
|
1452
|
-
}
|
|
1453
|
-
],
|
|
1454
|
-
"js": {
|
|
1455
|
-
"properties": [
|
|
1456
|
-
{
|
|
1457
|
-
"name": "direction",
|
|
1458
|
-
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1459
|
-
"value": {
|
|
1460
|
-
"type": [
|
|
1461
|
-
"string",
|
|
1462
|
-
"null",
|
|
1463
|
-
"undefined"
|
|
1464
|
-
]
|
|
1465
|
-
}
|
|
1466
|
-
},
|
|
1467
|
-
{
|
|
1468
|
-
"name": "path",
|
|
1469
|
-
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1470
|
-
"value": {
|
|
1471
|
-
"type": [
|
|
1472
|
-
"string",
|
|
1473
|
-
"null",
|
|
1474
|
-
"undefined"
|
|
1475
|
-
]
|
|
1476
|
-
}
|
|
1477
|
-
}
|
|
1478
|
-
],
|
|
1479
|
-
"events": [
|
|
1480
|
-
{
|
|
1481
|
-
"name": "direction-changed",
|
|
1482
|
-
"description": "Fired when the `direction` property changes."
|
|
1483
|
-
}
|
|
1484
|
-
]
|
|
1485
|
-
}
|
|
1486
|
-
},
|
|
1487
1204
|
{
|
|
1488
1205
|
"name": "vaadin-grid-sort-column",
|
|
1489
1206
|
"description": "`<vaadin-grid-sort-column>` is a helper element for the `<vaadin-grid>`\nthat provides default header renderer and functionality for sorting.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-sort-column path=\"name.first\" direction=\"asc\"></vaadin-grid-sort-column>\n\n <vaadin-grid-column>\n ...\n```",
|
|
@@ -1493,9 +1210,7 @@
|
|
|
1493
1210
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
1494
1211
|
"value": {
|
|
1495
1212
|
"type": [
|
|
1496
|
-
"boolean"
|
|
1497
|
-
"null",
|
|
1498
|
-
"undefined"
|
|
1213
|
+
"boolean"
|
|
1499
1214
|
]
|
|
1500
1215
|
}
|
|
1501
1216
|
},
|
|
@@ -1504,9 +1219,7 @@
|
|
|
1504
1219
|
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1505
1220
|
"value": {
|
|
1506
1221
|
"type": [
|
|
1507
|
-
"string"
|
|
1508
|
-
"null",
|
|
1509
|
-
"undefined"
|
|
1222
|
+
"string"
|
|
1510
1223
|
]
|
|
1511
1224
|
}
|
|
1512
1225
|
},
|
|
@@ -1515,9 +1228,7 @@
|
|
|
1515
1228
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
1516
1229
|
"value": {
|
|
1517
1230
|
"type": [
|
|
1518
|
-
"number"
|
|
1519
|
-
"null",
|
|
1520
|
-
"undefined"
|
|
1231
|
+
"number"
|
|
1521
1232
|
]
|
|
1522
1233
|
}
|
|
1523
1234
|
},
|
|
@@ -1526,9 +1237,7 @@
|
|
|
1526
1237
|
"description": "Custom part name for the footer cell.",
|
|
1527
1238
|
"value": {
|
|
1528
1239
|
"type": [
|
|
1529
|
-
"string"
|
|
1530
|
-
"null",
|
|
1531
|
-
"undefined"
|
|
1240
|
+
"string"
|
|
1532
1241
|
]
|
|
1533
1242
|
}
|
|
1534
1243
|
},
|
|
@@ -1537,9 +1246,7 @@
|
|
|
1537
1246
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
1538
1247
|
"value": {
|
|
1539
1248
|
"type": [
|
|
1540
|
-
"boolean"
|
|
1541
|
-
"null",
|
|
1542
|
-
"undefined"
|
|
1249
|
+
"boolean"
|
|
1543
1250
|
]
|
|
1544
1251
|
}
|
|
1545
1252
|
},
|
|
@@ -1548,9 +1255,7 @@
|
|
|
1548
1255
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
1549
1256
|
"value": {
|
|
1550
1257
|
"type": [
|
|
1551
|
-
"boolean"
|
|
1552
|
-
"null",
|
|
1553
|
-
"undefined"
|
|
1258
|
+
"boolean"
|
|
1554
1259
|
]
|
|
1555
1260
|
}
|
|
1556
1261
|
},
|
|
@@ -1559,9 +1264,7 @@
|
|
|
1559
1264
|
"description": "Text content to display in the header cell of the column.",
|
|
1560
1265
|
"value": {
|
|
1561
1266
|
"type": [
|
|
1562
|
-
"string"
|
|
1563
|
-
"null",
|
|
1564
|
-
"undefined"
|
|
1267
|
+
"string"
|
|
1565
1268
|
]
|
|
1566
1269
|
}
|
|
1567
1270
|
},
|
|
@@ -1570,9 +1273,7 @@
|
|
|
1570
1273
|
"description": "Custom part name for the header cell.",
|
|
1571
1274
|
"value": {
|
|
1572
1275
|
"type": [
|
|
1573
|
-
"string"
|
|
1574
|
-
"null",
|
|
1575
|
-
"undefined"
|
|
1276
|
+
"string"
|
|
1576
1277
|
]
|
|
1577
1278
|
}
|
|
1578
1279
|
},
|
|
@@ -1581,9 +1282,7 @@
|
|
|
1581
1282
|
"description": "When set to true, the cells for this column are hidden.",
|
|
1582
1283
|
"value": {
|
|
1583
1284
|
"type": [
|
|
1584
|
-
"boolean"
|
|
1585
|
-
"null",
|
|
1586
|
-
"undefined"
|
|
1285
|
+
"boolean"
|
|
1587
1286
|
]
|
|
1588
1287
|
}
|
|
1589
1288
|
},
|
|
@@ -1592,9 +1291,7 @@
|
|
|
1592
1291
|
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1593
1292
|
"value": {
|
|
1594
1293
|
"type": [
|
|
1595
|
-
"string"
|
|
1596
|
-
"null",
|
|
1597
|
-
"undefined"
|
|
1294
|
+
"string"
|
|
1598
1295
|
]
|
|
1599
1296
|
}
|
|
1600
1297
|
},
|
|
@@ -1603,9 +1300,7 @@
|
|
|
1603
1300
|
"description": "When set to true, the column is user-resizable.",
|
|
1604
1301
|
"value": {
|
|
1605
1302
|
"type": [
|
|
1606
|
-
"boolean"
|
|
1607
|
-
"null",
|
|
1608
|
-
"undefined"
|
|
1303
|
+
"boolean"
|
|
1609
1304
|
]
|
|
1610
1305
|
}
|
|
1611
1306
|
},
|
|
@@ -1614,9 +1309,7 @@
|
|
|
1614
1309
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
1615
1310
|
"value": {
|
|
1616
1311
|
"type": [
|
|
1617
|
-
"boolean"
|
|
1618
|
-
"null",
|
|
1619
|
-
"undefined"
|
|
1312
|
+
"boolean"
|
|
1620
1313
|
]
|
|
1621
1314
|
}
|
|
1622
1315
|
},
|
|
@@ -1625,9 +1318,7 @@
|
|
|
1625
1318
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
1626
1319
|
"value": {
|
|
1627
1320
|
"type": [
|
|
1628
|
-
"string"
|
|
1629
|
-
"null",
|
|
1630
|
-
"undefined"
|
|
1321
|
+
"string"
|
|
1631
1322
|
]
|
|
1632
1323
|
}
|
|
1633
1324
|
},
|
|
@@ -1647,9 +1338,7 @@
|
|
|
1647
1338
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
1648
1339
|
"value": {
|
|
1649
1340
|
"type": [
|
|
1650
|
-
"string"
|
|
1651
|
-
"null",
|
|
1652
|
-
"undefined"
|
|
1341
|
+
"string"
|
|
1653
1342
|
]
|
|
1654
1343
|
}
|
|
1655
1344
|
}
|
|
@@ -1661,9 +1350,7 @@
|
|
|
1661
1350
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
1662
1351
|
"value": {
|
|
1663
1352
|
"type": [
|
|
1664
|
-
"boolean"
|
|
1665
|
-
"null",
|
|
1666
|
-
"undefined"
|
|
1353
|
+
"boolean"
|
|
1667
1354
|
]
|
|
1668
1355
|
}
|
|
1669
1356
|
},
|
|
@@ -1672,9 +1359,7 @@
|
|
|
1672
1359
|
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1673
1360
|
"value": {
|
|
1674
1361
|
"type": [
|
|
1675
|
-
"string"
|
|
1676
|
-
"null",
|
|
1677
|
-
"undefined"
|
|
1362
|
+
"string"
|
|
1678
1363
|
]
|
|
1679
1364
|
}
|
|
1680
1365
|
},
|
|
@@ -1683,9 +1368,7 @@
|
|
|
1683
1368
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
1684
1369
|
"value": {
|
|
1685
1370
|
"type": [
|
|
1686
|
-
"number"
|
|
1687
|
-
"null",
|
|
1688
|
-
"undefined"
|
|
1371
|
+
"number"
|
|
1689
1372
|
]
|
|
1690
1373
|
}
|
|
1691
1374
|
},
|
|
@@ -1694,9 +1377,7 @@
|
|
|
1694
1377
|
"description": "Custom part name for the footer cell.",
|
|
1695
1378
|
"value": {
|
|
1696
1379
|
"type": [
|
|
1697
|
-
"string"
|
|
1698
|
-
"null",
|
|
1699
|
-
"undefined"
|
|
1380
|
+
"string"
|
|
1700
1381
|
]
|
|
1701
1382
|
}
|
|
1702
1383
|
},
|
|
@@ -1716,9 +1397,7 @@
|
|
|
1716
1397
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
1717
1398
|
"value": {
|
|
1718
1399
|
"type": [
|
|
1719
|
-
"boolean"
|
|
1720
|
-
"null",
|
|
1721
|
-
"undefined"
|
|
1400
|
+
"boolean"
|
|
1722
1401
|
]
|
|
1723
1402
|
}
|
|
1724
1403
|
},
|
|
@@ -1727,9 +1406,7 @@
|
|
|
1727
1406
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
1728
1407
|
"value": {
|
|
1729
1408
|
"type": [
|
|
1730
|
-
"boolean"
|
|
1731
|
-
"null",
|
|
1732
|
-
"undefined"
|
|
1409
|
+
"boolean"
|
|
1733
1410
|
]
|
|
1734
1411
|
}
|
|
1735
1412
|
},
|
|
@@ -1738,9 +1415,7 @@
|
|
|
1738
1415
|
"description": "Text content to display in the header cell of the column.",
|
|
1739
1416
|
"value": {
|
|
1740
1417
|
"type": [
|
|
1741
|
-
"string"
|
|
1742
|
-
"null",
|
|
1743
|
-
"undefined"
|
|
1418
|
+
"string"
|
|
1744
1419
|
]
|
|
1745
1420
|
}
|
|
1746
1421
|
},
|
|
@@ -1749,9 +1424,7 @@
|
|
|
1749
1424
|
"description": "Custom part name for the header cell.",
|
|
1750
1425
|
"value": {
|
|
1751
1426
|
"type": [
|
|
1752
|
-
"string"
|
|
1753
|
-
"null",
|
|
1754
|
-
"undefined"
|
|
1427
|
+
"string"
|
|
1755
1428
|
]
|
|
1756
1429
|
}
|
|
1757
1430
|
},
|
|
@@ -1771,9 +1444,7 @@
|
|
|
1771
1444
|
"description": "When set to true, the cells for this column are hidden.",
|
|
1772
1445
|
"value": {
|
|
1773
1446
|
"type": [
|
|
1774
|
-
"boolean"
|
|
1775
|
-
"null",
|
|
1776
|
-
"undefined"
|
|
1447
|
+
"boolean"
|
|
1777
1448
|
]
|
|
1778
1449
|
}
|
|
1779
1450
|
},
|
|
@@ -1782,9 +1453,7 @@
|
|
|
1782
1453
|
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1783
1454
|
"value": {
|
|
1784
1455
|
"type": [
|
|
1785
|
-
"string"
|
|
1786
|
-
"null",
|
|
1787
|
-
"undefined"
|
|
1456
|
+
"string"
|
|
1788
1457
|
]
|
|
1789
1458
|
}
|
|
1790
1459
|
},
|
|
@@ -1804,9 +1473,7 @@
|
|
|
1804
1473
|
"description": "When set to true, the column is user-resizable.",
|
|
1805
1474
|
"value": {
|
|
1806
1475
|
"type": [
|
|
1807
|
-
"boolean"
|
|
1808
|
-
"null",
|
|
1809
|
-
"undefined"
|
|
1476
|
+
"boolean"
|
|
1810
1477
|
]
|
|
1811
1478
|
}
|
|
1812
1479
|
},
|
|
@@ -1815,9 +1482,7 @@
|
|
|
1815
1482
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
1816
1483
|
"value": {
|
|
1817
1484
|
"type": [
|
|
1818
|
-
"boolean"
|
|
1819
|
-
"null",
|
|
1820
|
-
"undefined"
|
|
1485
|
+
"boolean"
|
|
1821
1486
|
]
|
|
1822
1487
|
}
|
|
1823
1488
|
},
|
|
@@ -1826,9 +1491,7 @@
|
|
|
1826
1491
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
1827
1492
|
"value": {
|
|
1828
1493
|
"type": [
|
|
1829
|
-
"string"
|
|
1830
|
-
"null",
|
|
1831
|
-
"undefined"
|
|
1494
|
+
"string"
|
|
1832
1495
|
]
|
|
1833
1496
|
}
|
|
1834
1497
|
},
|
|
@@ -1837,55 +1500,38 @@
|
|
|
1837
1500
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
1838
1501
|
"value": {
|
|
1839
1502
|
"type": [
|
|
1840
|
-
"string"
|
|
1841
|
-
"null",
|
|
1842
|
-
"undefined"
|
|
1503
|
+
"string"
|
|
1843
1504
|
]
|
|
1844
1505
|
}
|
|
1845
1506
|
}
|
|
1846
1507
|
],
|
|
1847
1508
|
"events": [
|
|
1848
|
-
{
|
|
1849
|
-
"name": "direction-changed",
|
|
1850
|
-
"description": "Fired when the `direction` property changes."
|
|
1851
|
-
}
|
|
1852
|
-
]
|
|
1853
|
-
}
|
|
1854
|
-
},
|
|
1855
|
-
{
|
|
1856
|
-
"name": "vaadin-grid-tree-toggle",
|
|
1857
|
-
"description": "`<vaadin-grid-tree-toggle>` is a helper element for the `<vaadin-grid>`\nthat provides toggle and level display functionality for the item tree.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.renderer = (root, column, model) => {\n let treeToggle = root.firstElementChild;\n if (!treeToggle) {\n treeToggle = document.createElement('vaadin-grid-tree-toggle');\n treeToggle.addEventListener('expanded-changed', () => { ... });\n root.appendChild(treeToggle);\n }\n treeToggle.leaf = !model.item.hasChildren;\n treeToggle.level = level;\n treeToggle.expanded = expanded;\n treeToggle.textContent = model.item.name;\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---|---\n`toggle` | The tree toggle icon\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------|-------------------------------------\n`expanded` | When present, the toggle is expanded\n`leaf` | When present, the toggle is not expandable, i. e., the current item is a leaf\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property | Description | Default\n---|---|---\n`--vaadin-grid-tree-toggle-level-offset` | Visual offset step for each tree sublevel | `1em`",
|
|
1858
|
-
"attributes": [
|
|
1859
|
-
{
|
|
1860
|
-
"name": "expanded",
|
|
1861
|
-
"description": "Sublevel toggle state.",
|
|
1862
|
-
"value": {
|
|
1863
|
-
"type": [
|
|
1864
|
-
"boolean",
|
|
1865
|
-
"null",
|
|
1866
|
-
"undefined"
|
|
1867
|
-
]
|
|
1509
|
+
{
|
|
1510
|
+
"name": "direction-changed",
|
|
1511
|
+
"description": "Fired when the `direction` property changes."
|
|
1868
1512
|
}
|
|
1869
|
-
|
|
1513
|
+
]
|
|
1514
|
+
}
|
|
1515
|
+
},
|
|
1516
|
+
{
|
|
1517
|
+
"name": "vaadin-grid-sorter",
|
|
1518
|
+
"description": "`<vaadin-grid-sorter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,\nvisual feedback, and handlers for sorting the grid data.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.renderer = (root, column, model) => {\n let sorter = root.firstElementChild;\n if (!sorter) {\n sorter = document.createElement('vaadin-grid-sorter');\n root.appendChild(sorter);\n }\n sorter.path = 'name.first';\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`content` | The slotted content wrapper\n`indicators` | The internal sorter indicators.\n`order` | The internal sorter order\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-------------|---------------------------\n`direction` | Sort direction of a sorter",
|
|
1519
|
+
"attributes": [
|
|
1870
1520
|
{
|
|
1871
|
-
"name": "
|
|
1872
|
-
"description": "
|
|
1521
|
+
"name": "direction",
|
|
1522
|
+
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1873
1523
|
"value": {
|
|
1874
1524
|
"type": [
|
|
1875
|
-
"
|
|
1876
|
-
"null",
|
|
1877
|
-
"undefined"
|
|
1525
|
+
"string"
|
|
1878
1526
|
]
|
|
1879
1527
|
}
|
|
1880
1528
|
},
|
|
1881
1529
|
{
|
|
1882
|
-
"name": "
|
|
1883
|
-
"description": "
|
|
1530
|
+
"name": "path",
|
|
1531
|
+
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1884
1532
|
"value": {
|
|
1885
1533
|
"type": [
|
|
1886
|
-
"
|
|
1887
|
-
"null",
|
|
1888
|
-
"undefined"
|
|
1534
|
+
"string"
|
|
1889
1535
|
]
|
|
1890
1536
|
}
|
|
1891
1537
|
},
|
|
@@ -1904,43 +1550,32 @@
|
|
|
1904
1550
|
"js": {
|
|
1905
1551
|
"properties": [
|
|
1906
1552
|
{
|
|
1907
|
-
"name": "
|
|
1908
|
-
"description": "
|
|
1909
|
-
"value": {
|
|
1910
|
-
"type": [
|
|
1911
|
-
"boolean",
|
|
1912
|
-
"null",
|
|
1913
|
-
"undefined"
|
|
1914
|
-
]
|
|
1915
|
-
}
|
|
1916
|
-
},
|
|
1917
|
-
{
|
|
1918
|
-
"name": "leaf",
|
|
1919
|
-
"description": "Hides the toggle icon and disables toggling a tree sublevel.",
|
|
1553
|
+
"name": "direction",
|
|
1554
|
+
"description": "How to sort the data.\nPossible values are `asc` to use an ascending algorithm, `desc` to sort the data in\ndescending direction, or `null` for not sorting the data.",
|
|
1920
1555
|
"value": {
|
|
1921
1556
|
"type": [
|
|
1922
|
-
"
|
|
1923
|
-
"null",
|
|
1924
|
-
"undefined"
|
|
1557
|
+
"string"
|
|
1925
1558
|
]
|
|
1926
1559
|
}
|
|
1927
1560
|
},
|
|
1928
1561
|
{
|
|
1929
|
-
"name": "
|
|
1930
|
-
"description": "
|
|
1562
|
+
"name": "path",
|
|
1563
|
+
"description": "JS Path of the property in the item used for sorting the data.",
|
|
1931
1564
|
"value": {
|
|
1932
1565
|
"type": [
|
|
1933
|
-
"
|
|
1934
|
-
"null",
|
|
1935
|
-
"undefined"
|
|
1566
|
+
"string"
|
|
1936
1567
|
]
|
|
1937
1568
|
}
|
|
1938
1569
|
}
|
|
1939
1570
|
],
|
|
1940
1571
|
"events": [
|
|
1941
1572
|
{
|
|
1942
|
-
"name": "
|
|
1943
|
-
"description": "Fired when the `
|
|
1573
|
+
"name": "direction-changed",
|
|
1574
|
+
"description": "Fired when the `direction` property changes."
|
|
1575
|
+
},
|
|
1576
|
+
{
|
|
1577
|
+
"name": "sorter-changed",
|
|
1578
|
+
"description": "Fired when the `path` or `direction` property changes."
|
|
1944
1579
|
}
|
|
1945
1580
|
]
|
|
1946
1581
|
}
|
|
@@ -1954,9 +1589,7 @@
|
|
|
1954
1589
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
1955
1590
|
"value": {
|
|
1956
1591
|
"type": [
|
|
1957
|
-
"boolean"
|
|
1958
|
-
"null",
|
|
1959
|
-
"undefined"
|
|
1592
|
+
"boolean"
|
|
1960
1593
|
]
|
|
1961
1594
|
}
|
|
1962
1595
|
},
|
|
@@ -1965,9 +1598,7 @@
|
|
|
1965
1598
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
1966
1599
|
"value": {
|
|
1967
1600
|
"type": [
|
|
1968
|
-
"number"
|
|
1969
|
-
"null",
|
|
1970
|
-
"undefined"
|
|
1601
|
+
"number"
|
|
1971
1602
|
]
|
|
1972
1603
|
}
|
|
1973
1604
|
},
|
|
@@ -1976,9 +1607,7 @@
|
|
|
1976
1607
|
"description": "Custom part name for the footer cell.",
|
|
1977
1608
|
"value": {
|
|
1978
1609
|
"type": [
|
|
1979
|
-
"string"
|
|
1980
|
-
"null",
|
|
1981
|
-
"undefined"
|
|
1610
|
+
"string"
|
|
1982
1611
|
]
|
|
1983
1612
|
}
|
|
1984
1613
|
},
|
|
@@ -1987,9 +1616,7 @@
|
|
|
1987
1616
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
1988
1617
|
"value": {
|
|
1989
1618
|
"type": [
|
|
1990
|
-
"boolean"
|
|
1991
|
-
"null",
|
|
1992
|
-
"undefined"
|
|
1619
|
+
"boolean"
|
|
1993
1620
|
]
|
|
1994
1621
|
}
|
|
1995
1622
|
},
|
|
@@ -1998,9 +1625,7 @@
|
|
|
1998
1625
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
1999
1626
|
"value": {
|
|
2000
1627
|
"type": [
|
|
2001
|
-
"boolean"
|
|
2002
|
-
"null",
|
|
2003
|
-
"undefined"
|
|
1628
|
+
"boolean"
|
|
2004
1629
|
]
|
|
2005
1630
|
}
|
|
2006
1631
|
},
|
|
@@ -2009,9 +1634,7 @@
|
|
|
2009
1634
|
"description": "Text content to display in the header cell of the column.",
|
|
2010
1635
|
"value": {
|
|
2011
1636
|
"type": [
|
|
2012
|
-
"string"
|
|
2013
|
-
"null",
|
|
2014
|
-
"undefined"
|
|
1637
|
+
"string"
|
|
2015
1638
|
]
|
|
2016
1639
|
}
|
|
2017
1640
|
},
|
|
@@ -2020,9 +1643,7 @@
|
|
|
2020
1643
|
"description": "Custom part name for the header cell.",
|
|
2021
1644
|
"value": {
|
|
2022
1645
|
"type": [
|
|
2023
|
-
"string"
|
|
2024
|
-
"null",
|
|
2025
|
-
"undefined"
|
|
1646
|
+
"string"
|
|
2026
1647
|
]
|
|
2027
1648
|
}
|
|
2028
1649
|
},
|
|
@@ -2031,9 +1652,7 @@
|
|
|
2031
1652
|
"description": "When set to true, the cells for this column are hidden.",
|
|
2032
1653
|
"value": {
|
|
2033
1654
|
"type": [
|
|
2034
|
-
"boolean"
|
|
2035
|
-
"null",
|
|
2036
|
-
"undefined"
|
|
1655
|
+
"boolean"
|
|
2037
1656
|
]
|
|
2038
1657
|
}
|
|
2039
1658
|
},
|
|
@@ -2042,9 +1661,7 @@
|
|
|
2042
1661
|
"description": "JS Path of the property in the item used as text content for the tree toggle.",
|
|
2043
1662
|
"value": {
|
|
2044
1663
|
"type": [
|
|
2045
|
-
"string"
|
|
2046
|
-
"null",
|
|
2047
|
-
"undefined"
|
|
1664
|
+
"string"
|
|
2048
1665
|
]
|
|
2049
1666
|
}
|
|
2050
1667
|
},
|
|
@@ -2053,9 +1670,7 @@
|
|
|
2053
1670
|
"description": "When set to true, the column is user-resizable.",
|
|
2054
1671
|
"value": {
|
|
2055
1672
|
"type": [
|
|
2056
|
-
"boolean"
|
|
2057
|
-
"null",
|
|
2058
|
-
"undefined"
|
|
1673
|
+
"boolean"
|
|
2059
1674
|
]
|
|
2060
1675
|
}
|
|
2061
1676
|
},
|
|
@@ -2064,9 +1679,7 @@
|
|
|
2064
1679
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
2065
1680
|
"value": {
|
|
2066
1681
|
"type": [
|
|
2067
|
-
"boolean"
|
|
2068
|
-
"null",
|
|
2069
|
-
"undefined"
|
|
1682
|
+
"boolean"
|
|
2070
1683
|
]
|
|
2071
1684
|
}
|
|
2072
1685
|
},
|
|
@@ -2075,9 +1688,7 @@
|
|
|
2075
1688
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
2076
1689
|
"value": {
|
|
2077
1690
|
"type": [
|
|
2078
|
-
"string"
|
|
2079
|
-
"null",
|
|
2080
|
-
"undefined"
|
|
1691
|
+
"string"
|
|
2081
1692
|
]
|
|
2082
1693
|
}
|
|
2083
1694
|
},
|
|
@@ -2097,9 +1708,7 @@
|
|
|
2097
1708
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
2098
1709
|
"value": {
|
|
2099
1710
|
"type": [
|
|
2100
|
-
"string"
|
|
2101
|
-
"null",
|
|
2102
|
-
"undefined"
|
|
1711
|
+
"string"
|
|
2103
1712
|
]
|
|
2104
1713
|
}
|
|
2105
1714
|
}
|
|
@@ -2111,9 +1720,7 @@
|
|
|
2111
1720
|
"description": "Automatically sets the width of the column based on the column contents when this is set to `true`.\n\nFor performance reasons the column width is calculated automatically only once when the grid items\nare rendered for the first time and the calculation only considers the rows which are currently\nrendered in DOM (a bit more than what is currently visible). If the grid is scrolled, or the cell\ncontent changes, the column width might not match the contents anymore.\n\nHidden columns are ignored in the calculation and their widths are not automatically updated when\nyou show a column that was initially hidden.\n\nYou can manually trigger the auto sizing behavior again by calling `grid.recalculateColumnWidths()`.\n\nThe column width may still grow larger when `flexGrow` is not 0.",
|
|
2112
1721
|
"value": {
|
|
2113
1722
|
"type": [
|
|
2114
|
-
"boolean"
|
|
2115
|
-
"null",
|
|
2116
|
-
"undefined"
|
|
1723
|
+
"boolean"
|
|
2117
1724
|
]
|
|
2118
1725
|
}
|
|
2119
1726
|
},
|
|
@@ -2122,9 +1729,7 @@
|
|
|
2122
1729
|
"description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
|
|
2123
1730
|
"value": {
|
|
2124
1731
|
"type": [
|
|
2125
|
-
"number"
|
|
2126
|
-
"null",
|
|
2127
|
-
"undefined"
|
|
1732
|
+
"number"
|
|
2128
1733
|
]
|
|
2129
1734
|
}
|
|
2130
1735
|
},
|
|
@@ -2133,9 +1738,7 @@
|
|
|
2133
1738
|
"description": "Custom part name for the footer cell.",
|
|
2134
1739
|
"value": {
|
|
2135
1740
|
"type": [
|
|
2136
|
-
"string"
|
|
2137
|
-
"null",
|
|
2138
|
-
"undefined"
|
|
1741
|
+
"string"
|
|
2139
1742
|
]
|
|
2140
1743
|
}
|
|
2141
1744
|
},
|
|
@@ -2155,9 +1758,7 @@
|
|
|
2155
1758
|
"description": "When true, the column is frozen. When a column inside of a column group is frozen,\nall of the sibling columns inside the group will get frozen also.",
|
|
2156
1759
|
"value": {
|
|
2157
1760
|
"type": [
|
|
2158
|
-
"boolean"
|
|
2159
|
-
"null",
|
|
2160
|
-
"undefined"
|
|
1761
|
+
"boolean"
|
|
2161
1762
|
]
|
|
2162
1763
|
}
|
|
2163
1764
|
},
|
|
@@ -2166,9 +1767,7 @@
|
|
|
2166
1767
|
"description": "When true, the column is frozen to end of grid.\n\nWhen a column inside of a column group is frozen to end, all of the sibling columns\ninside the group will get frozen to end also.\n\nColumn can not be set as `frozen` and `frozenToEnd` at the same time.",
|
|
2167
1768
|
"value": {
|
|
2168
1769
|
"type": [
|
|
2169
|
-
"boolean"
|
|
2170
|
-
"null",
|
|
2171
|
-
"undefined"
|
|
1770
|
+
"boolean"
|
|
2172
1771
|
]
|
|
2173
1772
|
}
|
|
2174
1773
|
},
|
|
@@ -2177,9 +1776,7 @@
|
|
|
2177
1776
|
"description": "Text content to display in the header cell of the column.",
|
|
2178
1777
|
"value": {
|
|
2179
1778
|
"type": [
|
|
2180
|
-
"string"
|
|
2181
|
-
"null",
|
|
2182
|
-
"undefined"
|
|
1779
|
+
"string"
|
|
2183
1780
|
]
|
|
2184
1781
|
}
|
|
2185
1782
|
},
|
|
@@ -2188,9 +1785,7 @@
|
|
|
2188
1785
|
"description": "Custom part name for the header cell.",
|
|
2189
1786
|
"value": {
|
|
2190
1787
|
"type": [
|
|
2191
|
-
"string"
|
|
2192
|
-
"null",
|
|
2193
|
-
"undefined"
|
|
1788
|
+
"string"
|
|
2194
1789
|
]
|
|
2195
1790
|
}
|
|
2196
1791
|
},
|
|
@@ -2210,9 +1805,7 @@
|
|
|
2210
1805
|
"description": "When set to true, the cells for this column are hidden.",
|
|
2211
1806
|
"value": {
|
|
2212
1807
|
"type": [
|
|
2213
|
-
"boolean"
|
|
2214
|
-
"null",
|
|
2215
|
-
"undefined"
|
|
1808
|
+
"boolean"
|
|
2216
1809
|
]
|
|
2217
1810
|
}
|
|
2218
1811
|
},
|
|
@@ -2221,9 +1814,7 @@
|
|
|
2221
1814
|
"description": "JS Path of the property in the item used as text content for the tree toggle.",
|
|
2222
1815
|
"value": {
|
|
2223
1816
|
"type": [
|
|
2224
|
-
"string"
|
|
2225
|
-
"null",
|
|
2226
|
-
"undefined"
|
|
1817
|
+
"string"
|
|
2227
1818
|
]
|
|
2228
1819
|
}
|
|
2229
1820
|
},
|
|
@@ -2243,9 +1834,7 @@
|
|
|
2243
1834
|
"description": "When set to true, the column is user-resizable.",
|
|
2244
1835
|
"value": {
|
|
2245
1836
|
"type": [
|
|
2246
|
-
"boolean"
|
|
2247
|
-
"null",
|
|
2248
|
-
"undefined"
|
|
1837
|
+
"boolean"
|
|
2249
1838
|
]
|
|
2250
1839
|
}
|
|
2251
1840
|
},
|
|
@@ -2254,9 +1843,7 @@
|
|
|
2254
1843
|
"description": "When true, the cells for this column will be rendered with the `role` attribute\nset as `rowheader`, instead of the `gridcell` role value used by default.\n\nWhen a column is set as row header, its cells will be announced by screen readers\nwhile navigating to help user identify the current row as uniquely as possible.",
|
|
2255
1844
|
"value": {
|
|
2256
1845
|
"type": [
|
|
2257
|
-
"boolean"
|
|
2258
|
-
"null",
|
|
2259
|
-
"undefined"
|
|
1846
|
+
"boolean"
|
|
2260
1847
|
]
|
|
2261
1848
|
}
|
|
2262
1849
|
},
|
|
@@ -2265,9 +1852,7 @@
|
|
|
2265
1852
|
"description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
|
|
2266
1853
|
"value": {
|
|
2267
1854
|
"type": [
|
|
2268
|
-
"string"
|
|
2269
|
-
"null",
|
|
2270
|
-
"undefined"
|
|
1855
|
+
"string"
|
|
2271
1856
|
]
|
|
2272
1857
|
}
|
|
2273
1858
|
},
|
|
@@ -2276,9 +1861,7 @@
|
|
|
2276
1861
|
"description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.",
|
|
2277
1862
|
"value": {
|
|
2278
1863
|
"type": [
|
|
2279
|
-
"string"
|
|
2280
|
-
"null",
|
|
2281
|
-
"undefined"
|
|
1864
|
+
"string"
|
|
2282
1865
|
]
|
|
2283
1866
|
}
|
|
2284
1867
|
}
|
|
@@ -2287,12 +1870,39 @@
|
|
|
2287
1870
|
}
|
|
2288
1871
|
},
|
|
2289
1872
|
{
|
|
2290
|
-
"name": "vaadin-grid",
|
|
2291
|
-
"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/25.2.0-alpha9/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/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`hasChildren` | Boolean | True if the item has children\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha9/#/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.js` entrypoint.\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/25.2.0-alpha9/#/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/25.2.0-alpha9/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\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`body-row` | Body row in the internal table\n`header-row` | Header row in the internal table\n`footer-row` | Footer row in the internal table\n`collapsed-row` | Collapsed row\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`nonselectable-row` | Row that the user may not select or deselect\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`first-header-row` | The first header row\n`first-footer-row` | The first footer row\n`last-row` | The last body row\n`last-header-row` | The last header row\n`last-footer-row` | The last footer row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\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`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`nonselectable-row-cell` | Cell in a row that the user may not select or deselect\n`collapsed-row-cell` | Cell in a collapsed row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in the ghost image row, but not in a source row\n`drag-source-row-cell` | Cell in a source row, but not in the ghost image\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`empty-state` | The container for the content to be displayed when there are no body rows to show\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`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | 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 starting to drag a row. The value is a number when dragging multiple rows | 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/styling-components) documentation.",
|
|
1873
|
+
"name": "vaadin-grid-tree-toggle",
|
|
1874
|
+
"description": "`<vaadin-grid-tree-toggle>` is a helper element for the `<vaadin-grid>`\nthat provides toggle and level display functionality for the item tree.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.renderer = (root, column, model) => {\n let treeToggle = root.firstElementChild;\n if (!treeToggle) {\n treeToggle = document.createElement('vaadin-grid-tree-toggle');\n treeToggle.addEventListener('expanded-changed', () => { ... });\n root.appendChild(treeToggle);\n }\n treeToggle.leaf = !model.item.hasChildren;\n treeToggle.level = level;\n treeToggle.expanded = expanded;\n treeToggle.textContent = model.item.name;\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---|---\n`toggle` | The tree toggle icon\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------|-------------------------------------\n`expanded` | When present, the toggle is expanded\n`leaf` | When present, the toggle is not expandable, i. e., the current item is a leaf\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property | Description | Default\n---|---|---\n`--vaadin-grid-tree-toggle-level-offset` | Visual offset step for each tree sublevel | `1em`",
|
|
2292
1875
|
"attributes": [
|
|
2293
1876
|
{
|
|
2294
|
-
"name": "
|
|
2295
|
-
"description": "
|
|
1877
|
+
"name": "expanded",
|
|
1878
|
+
"description": "Sublevel toggle state.",
|
|
1879
|
+
"value": {
|
|
1880
|
+
"type": [
|
|
1881
|
+
"boolean"
|
|
1882
|
+
]
|
|
1883
|
+
}
|
|
1884
|
+
},
|
|
1885
|
+
{
|
|
1886
|
+
"name": "leaf",
|
|
1887
|
+
"description": "Hides the toggle icon and disables toggling a tree sublevel.",
|
|
1888
|
+
"value": {
|
|
1889
|
+
"type": [
|
|
1890
|
+
"boolean"
|
|
1891
|
+
]
|
|
1892
|
+
}
|
|
1893
|
+
},
|
|
1894
|
+
{
|
|
1895
|
+
"name": "level",
|
|
1896
|
+
"description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
|
|
1897
|
+
"value": {
|
|
1898
|
+
"type": [
|
|
1899
|
+
"number"
|
|
1900
|
+
]
|
|
1901
|
+
}
|
|
1902
|
+
},
|
|
1903
|
+
{
|
|
1904
|
+
"name": "theme",
|
|
1905
|
+
"description": "The theme variants to apply to the component.",
|
|
2296
1906
|
"value": {
|
|
2297
1907
|
"type": [
|
|
2298
1908
|
"string",
|
|
@@ -2300,15 +1910,65 @@
|
|
|
2300
1910
|
"undefined"
|
|
2301
1911
|
]
|
|
2302
1912
|
}
|
|
1913
|
+
}
|
|
1914
|
+
],
|
|
1915
|
+
"js": {
|
|
1916
|
+
"properties": [
|
|
1917
|
+
{
|
|
1918
|
+
"name": "expanded",
|
|
1919
|
+
"description": "Sublevel toggle state.",
|
|
1920
|
+
"value": {
|
|
1921
|
+
"type": [
|
|
1922
|
+
"boolean"
|
|
1923
|
+
]
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "leaf",
|
|
1928
|
+
"description": "Hides the toggle icon and disables toggling a tree sublevel.",
|
|
1929
|
+
"value": {
|
|
1930
|
+
"type": [
|
|
1931
|
+
"boolean"
|
|
1932
|
+
]
|
|
1933
|
+
}
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "level",
|
|
1937
|
+
"description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
|
|
1938
|
+
"value": {
|
|
1939
|
+
"type": [
|
|
1940
|
+
"number"
|
|
1941
|
+
]
|
|
1942
|
+
}
|
|
1943
|
+
}
|
|
1944
|
+
],
|
|
1945
|
+
"events": [
|
|
1946
|
+
{
|
|
1947
|
+
"name": "expanded-changed",
|
|
1948
|
+
"description": "Fired when the `expanded` property changes."
|
|
1949
|
+
}
|
|
1950
|
+
]
|
|
1951
|
+
}
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
"name": "vaadin-grid",
|
|
1955
|
+
"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/25.2.0-beta1/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/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`hasChildren` | Boolean | True if the item has children\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-beta1/#/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.js` entrypoint.\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/25.2.0-beta1/#/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/25.2.0-beta1/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\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`body-row` | Body row in the internal table\n`header-row` | Header row in the internal table\n`footer-row` | Footer row in the internal table\n`collapsed-row` | Collapsed row\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`nonselectable-row` | Row that the user may not select or deselect\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`first-header-row` | The first header row\n`first-footer-row` | The first footer row\n`last-row` | The last body row\n`last-header-row` | The last header row\n`last-footer-row` | The last footer row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\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`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`nonselectable-row-cell` | Cell in a row that the user may not select or deselect\n`collapsed-row-cell` | Cell in a collapsed row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in the ghost image row, but not in a source row\n`drag-source-row-cell` | Cell in a source row, but not in the ghost image\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`empty-state` | The container for the content to be displayed when there are no body rows to show\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`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | 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 starting to drag a row. The value is a number when dragging multiple rows | 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/styling-components) documentation.",
|
|
1956
|
+
"attributes": [
|
|
1957
|
+
{
|
|
1958
|
+
"name": "accessible-name",
|
|
1959
|
+
"description": "String used to label the grid to screen reader users.",
|
|
1960
|
+
"value": {
|
|
1961
|
+
"type": [
|
|
1962
|
+
"string"
|
|
1963
|
+
]
|
|
1964
|
+
}
|
|
2303
1965
|
},
|
|
2304
1966
|
{
|
|
2305
1967
|
"name": "all-rows-visible",
|
|
2306
1968
|
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
2307
1969
|
"value": {
|
|
2308
1970
|
"type": [
|
|
2309
|
-
"boolean"
|
|
2310
|
-
"null",
|
|
2311
|
-
"undefined"
|
|
1971
|
+
"boolean"
|
|
2312
1972
|
]
|
|
2313
1973
|
}
|
|
2314
1974
|
},
|
|
@@ -2317,9 +1977,7 @@
|
|
|
2317
1977
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
2318
1978
|
"value": {
|
|
2319
1979
|
"type": [
|
|
2320
|
-
"string"
|
|
2321
|
-
"null",
|
|
2322
|
-
"undefined"
|
|
1980
|
+
"string"
|
|
2323
1981
|
]
|
|
2324
1982
|
}
|
|
2325
1983
|
},
|
|
@@ -2328,9 +1986,16 @@
|
|
|
2328
1986
|
"description": "Set to true to allow column reordering.",
|
|
2329
1987
|
"value": {
|
|
2330
1988
|
"type": [
|
|
2331
|
-
"boolean"
|
|
2332
|
-
|
|
2333
|
-
|
|
1989
|
+
"boolean"
|
|
1990
|
+
]
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
{
|
|
1994
|
+
"name": "disabled",
|
|
1995
|
+
"description": "If true, the user cannot interact with this element.",
|
|
1996
|
+
"value": {
|
|
1997
|
+
"type": [
|
|
1998
|
+
"boolean"
|
|
2334
1999
|
]
|
|
2335
2000
|
}
|
|
2336
2001
|
},
|
|
@@ -2339,9 +2004,7 @@
|
|
|
2339
2004
|
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
2340
2005
|
"value": {
|
|
2341
2006
|
"type": [
|
|
2342
|
-
"string"
|
|
2343
|
-
"null",
|
|
2344
|
-
"undefined"
|
|
2007
|
+
"string"
|
|
2345
2008
|
]
|
|
2346
2009
|
}
|
|
2347
2010
|
},
|
|
@@ -2350,9 +2013,7 @@
|
|
|
2350
2013
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
2351
2014
|
"value": {
|
|
2352
2015
|
"type": [
|
|
2353
|
-
"string"
|
|
2354
|
-
"null",
|
|
2355
|
-
"undefined"
|
|
2016
|
+
"string"
|
|
2356
2017
|
]
|
|
2357
2018
|
}
|
|
2358
2019
|
},
|
|
@@ -2361,9 +2022,7 @@
|
|
|
2361
2022
|
"description": "Path to an item sub-property that identifies the item.",
|
|
2362
2023
|
"value": {
|
|
2363
2024
|
"type": [
|
|
2364
|
-
"string"
|
|
2365
|
-
"null",
|
|
2366
|
-
"undefined"
|
|
2025
|
+
"string"
|
|
2367
2026
|
]
|
|
2368
2027
|
}
|
|
2369
2028
|
},
|
|
@@ -2372,9 +2031,7 @@
|
|
|
2372
2031
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
2373
2032
|
"value": {
|
|
2374
2033
|
"type": [
|
|
2375
|
-
"boolean"
|
|
2376
|
-
"null",
|
|
2377
|
-
"undefined"
|
|
2034
|
+
"boolean"
|
|
2378
2035
|
]
|
|
2379
2036
|
}
|
|
2380
2037
|
},
|
|
@@ -2383,9 +2040,7 @@
|
|
|
2383
2040
|
"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.",
|
|
2384
2041
|
"value": {
|
|
2385
2042
|
"type": [
|
|
2386
|
-
"boolean"
|
|
2387
|
-
"null",
|
|
2388
|
-
"undefined"
|
|
2043
|
+
"boolean"
|
|
2389
2044
|
]
|
|
2390
2045
|
}
|
|
2391
2046
|
},
|
|
@@ -2394,9 +2049,7 @@
|
|
|
2394
2049
|
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
2395
2050
|
"value": {
|
|
2396
2051
|
"type": [
|
|
2397
|
-
"string"
|
|
2398
|
-
"null",
|
|
2399
|
-
"undefined"
|
|
2052
|
+
"string"
|
|
2400
2053
|
]
|
|
2401
2054
|
}
|
|
2402
2055
|
},
|
|
@@ -2405,9 +2058,7 @@
|
|
|
2405
2058
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
2406
2059
|
"value": {
|
|
2407
2060
|
"type": [
|
|
2408
|
-
"number"
|
|
2409
|
-
"null",
|
|
2410
|
-
"undefined"
|
|
2061
|
+
"number"
|
|
2411
2062
|
]
|
|
2412
2063
|
}
|
|
2413
2064
|
},
|
|
@@ -2416,9 +2067,7 @@
|
|
|
2416
2067
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
2417
2068
|
"value": {
|
|
2418
2069
|
"type": [
|
|
2419
|
-
"boolean"
|
|
2420
|
-
"null",
|
|
2421
|
-
"undefined"
|
|
2070
|
+
"boolean"
|
|
2422
2071
|
]
|
|
2423
2072
|
}
|
|
2424
2073
|
},
|
|
@@ -2427,9 +2076,7 @@
|
|
|
2427
2076
|
"description": "The number of root-level items in the grid.",
|
|
2428
2077
|
"value": {
|
|
2429
2078
|
"type": [
|
|
2430
|
-
"number"
|
|
2431
|
-
"null",
|
|
2432
|
-
"undefined"
|
|
2079
|
+
"number"
|
|
2433
2080
|
]
|
|
2434
2081
|
}
|
|
2435
2082
|
},
|
|
@@ -2452,9 +2099,7 @@
|
|
|
2452
2099
|
"description": "String used to label the grid to screen reader users.",
|
|
2453
2100
|
"value": {
|
|
2454
2101
|
"type": [
|
|
2455
|
-
"string"
|
|
2456
|
-
"null",
|
|
2457
|
-
"undefined"
|
|
2102
|
+
"string"
|
|
2458
2103
|
]
|
|
2459
2104
|
}
|
|
2460
2105
|
},
|
|
@@ -2472,9 +2117,7 @@
|
|
|
2472
2117
|
"description": "If true, the grid's height is defined by its rows.\n\nEffectively, this disables the grid's virtual scrolling so that all the rows are rendered in the DOM at once.\nIf the grid has a large number of items, using the feature is discouraged to avoid performance issues.",
|
|
2473
2118
|
"value": {
|
|
2474
2119
|
"type": [
|
|
2475
|
-
"boolean"
|
|
2476
|
-
"null",
|
|
2477
|
-
"undefined"
|
|
2120
|
+
"boolean"
|
|
2478
2121
|
]
|
|
2479
2122
|
}
|
|
2480
2123
|
},
|
|
@@ -2494,9 +2137,7 @@
|
|
|
2494
2137
|
"description": "Allows you to choose between modes for rendering columns in the grid:\n\n\"eager\" (default): All columns are rendered upfront, regardless of their visibility within the viewport.\nThis mode should generally be preferred, as it avoids the limitations imposed by the \"lazy\" mode.\nUse this mode unless the grid has a large number of columns and performance outweighs the limitations\nin priority.\n\n\"lazy\": Optimizes the rendering of cells when there are multiple columns in the grid by virtualizing\nhorizontal scrolling. In this mode, body cells are rendered only when their corresponding columns are\ninside the visible viewport.\n\nUsing \"lazy\" rendering should be used only if you're dealing with a large number of columns and performance\nis your highest priority. For most use cases, the default \"eager\" mode is recommended due to the\nlimitations imposed by the \"lazy\" mode.\n\nWhen using the \"lazy\" mode, keep the following limitations in mind:\n\n- Row Height: When only a number of columns are visible at once, the height of a row can only be that of\nthe highest cell currently visible on that row. Make sure each cell on a single row has the same height\nas all other cells on that row. If row cells have different heights, users may experience jumpiness when\nscrolling the grid horizontally as lazily rendered cells with different heights are scrolled into view.\n\n- Auto-width Columns: For the columns that are initially outside the visible viewport but still use auto-width,\nonly the header content is taken into account when calculating the column width because the body cells\nof the columns outside the viewport are not initially rendered.\n\n- Screen Reader Compatibility: Screen readers may not be able to associate the focused cells with the correct\nheaders when only a subset of the body cells on a row is rendered.\n\n- Keyboard Navigation: Tabbing through focusable elements inside the grid body may not work as expected because\nsome of the columns that would include focusable elements in the body cells may be outside the visible viewport\nand thus not rendered.",
|
|
2495
2138
|
"value": {
|
|
2496
2139
|
"type": [
|
|
2497
|
-
"string"
|
|
2498
|
-
"null",
|
|
2499
|
-
"undefined"
|
|
2140
|
+
"string"
|
|
2500
2141
|
]
|
|
2501
2142
|
}
|
|
2502
2143
|
},
|
|
@@ -2505,9 +2146,7 @@
|
|
|
2505
2146
|
"description": "Set to true to allow column reordering.",
|
|
2506
2147
|
"value": {
|
|
2507
2148
|
"type": [
|
|
2508
|
-
"boolean"
|
|
2509
|
-
"null",
|
|
2510
|
-
"undefined"
|
|
2149
|
+
"boolean"
|
|
2511
2150
|
]
|
|
2512
2151
|
}
|
|
2513
2152
|
},
|
|
@@ -2527,7 +2166,16 @@
|
|
|
2527
2166
|
"description": "An array containing references to items with open row details.",
|
|
2528
2167
|
"value": {
|
|
2529
2168
|
"type": [
|
|
2530
|
-
"Array
|
|
2169
|
+
"Array<GridItem>"
|
|
2170
|
+
]
|
|
2171
|
+
}
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"name": "disabled",
|
|
2175
|
+
"description": "If true, the user cannot interact with this element.",
|
|
2176
|
+
"value": {
|
|
2177
|
+
"type": [
|
|
2178
|
+
"boolean"
|
|
2531
2179
|
]
|
|
2532
2180
|
}
|
|
2533
2181
|
},
|
|
@@ -2558,9 +2206,7 @@
|
|
|
2558
2206
|
"description": "Defines the locations within the Grid row where an element can be dropped.\n\nPossible values are:\n- `between`: The drop event can happen between Grid rows.\n- `on-top`: The drop event can happen on top of Grid rows.\n- `on-top-or-between`: The drop event can happen either on top of or between Grid rows.\n- `on-grid`: The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.",
|
|
2559
2207
|
"value": {
|
|
2560
2208
|
"type": [
|
|
2561
|
-
"string"
|
|
2562
|
-
"null",
|
|
2563
|
-
"undefined"
|
|
2209
|
+
"string"
|
|
2564
2210
|
]
|
|
2565
2211
|
}
|
|
2566
2212
|
},
|
|
@@ -2569,7 +2215,7 @@
|
|
|
2569
2215
|
"description": "An array that contains the expanded items.",
|
|
2570
2216
|
"value": {
|
|
2571
2217
|
"type": [
|
|
2572
|
-
"Array
|
|
2218
|
+
"Array<GridItem>"
|
|
2573
2219
|
]
|
|
2574
2220
|
}
|
|
2575
2221
|
},
|
|
@@ -2578,9 +2224,7 @@
|
|
|
2578
2224
|
"description": "A function to check whether a specific item in the grid may be\nselected or deselected by the user. Used by the selection column to\nconditionally enable to disable checkboxes for individual items. This\nfunction does not prevent programmatic selection/deselection of\nitems. Changing the function does not modify the currently selected\nitems.\n\nConfiguring this function hides the select all checkbox of the grid\nselection column, which means users can not select or deselect all\nitems anymore, nor do they get feedback on whether all items are\nselected or not.\n\nReceives an item instance and should return a boolean indicating\nwhether users may change the selection state of that item.",
|
|
2579
2225
|
"value": {
|
|
2580
2226
|
"type": [
|
|
2581
|
-
"
|
|
2582
|
-
"null",
|
|
2583
|
-
"undefined"
|
|
2227
|
+
"item: GridItem => boolean"
|
|
2584
2228
|
]
|
|
2585
2229
|
}
|
|
2586
2230
|
},
|
|
@@ -2589,9 +2233,7 @@
|
|
|
2589
2233
|
"description": "Path to an item sub-property that indicates whether the item has child items.",
|
|
2590
2234
|
"value": {
|
|
2591
2235
|
"type": [
|
|
2592
|
-
"string"
|
|
2593
|
-
"null",
|
|
2594
|
-
"undefined"
|
|
2236
|
+
"string"
|
|
2595
2237
|
]
|
|
2596
2238
|
}
|
|
2597
2239
|
},
|
|
@@ -2600,9 +2242,7 @@
|
|
|
2600
2242
|
"description": "Path to an item sub-property that identifies the item.",
|
|
2601
2243
|
"value": {
|
|
2602
2244
|
"type": [
|
|
2603
|
-
"string"
|
|
2604
|
-
"null",
|
|
2605
|
-
"undefined"
|
|
2245
|
+
"string"
|
|
2606
2246
|
]
|
|
2607
2247
|
}
|
|
2608
2248
|
},
|
|
@@ -2611,7 +2251,7 @@
|
|
|
2611
2251
|
"description": "An array containing the items which will be passed to renderer functions.",
|
|
2612
2252
|
"value": {
|
|
2613
2253
|
"type": [
|
|
2614
|
-
"Array
|
|
2254
|
+
"Array<GridItem>",
|
|
2615
2255
|
"undefined"
|
|
2616
2256
|
]
|
|
2617
2257
|
}
|
|
@@ -2621,9 +2261,7 @@
|
|
|
2621
2261
|
"description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
|
|
2622
2262
|
"value": {
|
|
2623
2263
|
"type": [
|
|
2624
|
-
"boolean"
|
|
2625
|
-
"null",
|
|
2626
|
-
"undefined"
|
|
2264
|
+
"boolean"
|
|
2627
2265
|
]
|
|
2628
2266
|
}
|
|
2629
2267
|
},
|
|
@@ -2632,9 +2270,7 @@
|
|
|
2632
2270
|
"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.",
|
|
2633
2271
|
"value": {
|
|
2634
2272
|
"type": [
|
|
2635
|
-
"boolean"
|
|
2636
|
-
"null",
|
|
2637
|
-
"undefined"
|
|
2273
|
+
"boolean"
|
|
2638
2274
|
]
|
|
2639
2275
|
}
|
|
2640
2276
|
},
|
|
@@ -2643,9 +2279,7 @@
|
|
|
2643
2279
|
"description": "Controls how columns are added to the sort order when using multi-sort.\nThe sort order is visually indicated by numbers in grid sorters placed in column headers.\n\nBy default, whenever an unsorted column is sorted, or the sort-direction of a column is\nchanged, that column gets sort priority 1, thus affecting the priority for all the other\nsorted columns. This is identical to using `multi-sort-priority=\"prepend\"`.\n\nUsing this property allows to change this behavior so that sorting an unsorted column\nwould add it to the \"end\" of the sort, and changing column's sort direction would retain\nit's previous priority. To set this, use `multi-sort-priority=\"append\"`.",
|
|
2644
2280
|
"value": {
|
|
2645
2281
|
"type": [
|
|
2646
|
-
"string"
|
|
2647
|
-
"null",
|
|
2648
|
-
"undefined"
|
|
2282
|
+
"string"
|
|
2649
2283
|
]
|
|
2650
2284
|
}
|
|
2651
2285
|
},
|
|
@@ -2654,9 +2288,7 @@
|
|
|
2654
2288
|
"description": "Number of items fetched at a time from the dataprovider.",
|
|
2655
2289
|
"value": {
|
|
2656
2290
|
"type": [
|
|
2657
|
-
"number"
|
|
2658
|
-
"null",
|
|
2659
|
-
"undefined"
|
|
2291
|
+
"number"
|
|
2660
2292
|
]
|
|
2661
2293
|
}
|
|
2662
2294
|
},
|
|
@@ -2676,9 +2308,7 @@
|
|
|
2676
2308
|
"description": "Marks the grid's rows to be available for dragging.",
|
|
2677
2309
|
"value": {
|
|
2678
2310
|
"type": [
|
|
2679
|
-
"boolean"
|
|
2680
|
-
"null",
|
|
2681
|
-
"undefined"
|
|
2311
|
+
"boolean"
|
|
2682
2312
|
]
|
|
2683
2313
|
}
|
|
2684
2314
|
},
|
|
@@ -2687,7 +2317,7 @@
|
|
|
2687
2317
|
"description": "An array that contains the selected items.",
|
|
2688
2318
|
"value": {
|
|
2689
2319
|
"type": [
|
|
2690
|
-
"Array
|
|
2320
|
+
"Array<GridItem>"
|
|
2691
2321
|
]
|
|
2692
2322
|
}
|
|
2693
2323
|
},
|
|
@@ -2696,9 +2326,7 @@
|
|
|
2696
2326
|
"description": "The number of root-level items in the grid.",
|
|
2697
2327
|
"value": {
|
|
2698
2328
|
"type": [
|
|
2699
|
-
"number"
|
|
2700
|
-
"null",
|
|
2701
|
-
"undefined"
|
|
2329
|
+
"number"
|
|
2702
2330
|
]
|
|
2703
2331
|
}
|
|
2704
2332
|
}
|
|
@@ -2714,7 +2342,7 @@
|
|
|
2714
2342
|
},
|
|
2715
2343
|
{
|
|
2716
2344
|
"name": "cell-focus",
|
|
2717
|
-
"description": "Fired when a cell is focused with click or keyboard navigation
|
|
2345
|
+
"description": "Fired when a cell is focused with click or keyboard navigation. Use the `context` property to read event details."
|
|
2718
2346
|
},
|
|
2719
2347
|
{
|
|
2720
2348
|
"name": "column-reorder",
|
|
@@ -2722,7 +2350,7 @@
|
|
|
2722
2350
|
},
|
|
2723
2351
|
{
|
|
2724
2352
|
"name": "column-resize",
|
|
2725
|
-
"description": "Fired when
|
|
2353
|
+
"description": "Fired when the grid column resize is finished."
|
|
2726
2354
|
},
|
|
2727
2355
|
{
|
|
2728
2356
|
"name": "data-provider-changed",
|