@vaadin/grid 25.2.0-alpha1 → 25.2.0-alpha10

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.
Files changed (27) hide show
  1. package/custom-elements.json +53 -1
  2. package/package.json +12 -12
  3. package/src/vaadin-grid-a11y-mixin.js +2 -2
  4. package/src/vaadin-grid-active-item-mixin.js +0 -12
  5. package/src/vaadin-grid-column-auto-width-mixin.js +1 -2
  6. package/src/vaadin-grid-column-group.d.ts +3 -1
  7. package/src/vaadin-grid-column-mixin.js +2 -2
  8. package/src/vaadin-grid-column-reordering-mixin.js +33 -11
  9. package/src/vaadin-grid-column-resizing-mixin.js +0 -8
  10. package/src/vaadin-grid-column.d.ts +5 -2
  11. package/src/vaadin-grid-data-provider-mixin.js +0 -28
  12. package/src/vaadin-grid-drag-and-drop-mixin.js +1 -41
  13. package/src/vaadin-grid-dynamic-columns-mixin.js +1 -1
  14. package/src/vaadin-grid-event-context-mixin.js +1 -1
  15. package/src/vaadin-grid-filter-column.d.ts +3 -1
  16. package/src/vaadin-grid-helpers.js +1 -1
  17. package/src/vaadin-grid-keyboard-navigation-mixin.js +1 -9
  18. package/src/vaadin-grid-mixin.js +5 -7
  19. package/src/vaadin-grid-row-details-mixin.js +30 -13
  20. package/src/vaadin-grid-selection-column.d.ts +3 -1
  21. package/src/vaadin-grid-selection-mixin.js +8 -17
  22. package/src/vaadin-grid-sort-column.d.ts +3 -1
  23. package/src/vaadin-grid-tree-column.d.ts +3 -1
  24. package/src/vaadin-grid.d.ts +1 -1
  25. package/src/vaadin-grid.js +1 -1
  26. package/web-types.json +401 -769
  27. package/web-types.lit.json +251 -230
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-alpha1",
4
+ "version": "25.2.0-alpha10",
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-alpha1/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
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-alpha10/#/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,118 @@
1002
791
  }
1003
792
  },
1004
793
  {
1005
- "name": "vaadin-grid-selection-column",
1006
- "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-alpha1/#/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__",
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": "auto-select",
1010
- "description": "When true, the active item gets automatically selected.",
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
- "boolean",
1025
- "null",
1026
- "undefined"
802
+ "string"
1027
803
  ]
1028
804
  }
1029
805
  },
1030
806
  {
1031
- "name": "drag-select",
1032
- "description": "When true, rows can be selected by dragging over the selection column.",
807
+ "name": "theme",
808
+ "description": "The theme variants to apply to the component.",
1033
809
  "value": {
1034
810
  "type": [
1035
- "boolean",
811
+ "string",
1036
812
  "null",
1037
813
  "undefined"
1038
814
  ]
1039
815
  }
1040
816
  },
1041
817
  {
1042
- "name": "flex-grow",
1043
- "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
818
+ "name": "value",
819
+ "description": "Current filter value.",
1044
820
  "value": {
1045
821
  "type": [
1046
- "number",
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": "filter-changed",
851
+ "description": ""
852
+ },
853
+ {
854
+ "name": "value-changed",
855
+ "description": "Fired when the `value` property changes."
856
+ }
857
+ ]
858
+ }
859
+ },
860
+ {
861
+ "name": "vaadin-grid-selection-column",
862
+ "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-alpha10/#/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__",
863
+ "attributes": [
864
+ {
865
+ "name": "auto-select",
866
+ "description": "When true, the active item gets automatically selected.",
867
+ "value": {
868
+ "type": [
869
+ "boolean"
870
+ ]
871
+ }
872
+ },
873
+ {
874
+ "name": "auto-width",
875
+ "description": "Override `autoWidth` to enable auto-width",
876
+ "value": {
877
+ "type": [
878
+ "boolean"
879
+ ]
880
+ }
881
+ },
882
+ {
883
+ "name": "drag-select",
884
+ "description": "When true, rows can be selected by dragging over the selection column.",
885
+ "value": {
886
+ "type": [
887
+ "boolean"
888
+ ]
889
+ }
890
+ },
891
+ {
892
+ "name": "flex-grow",
893
+ "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
894
+ "value": {
895
+ "type": [
896
+ "number"
897
+ ]
898
+ }
899
+ },
1052
900
  {
1053
901
  "name": "footer-part-name",
1054
902
  "description": "Custom part name for the footer cell.",
1055
903
  "value": {
1056
904
  "type": [
1057
- "string",
1058
- "null",
1059
- "undefined"
905
+ "string"
1060
906
  ]
1061
907
  }
1062
908
  },
@@ -1065,9 +911,7 @@
1065
911
  "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
912
  "value": {
1067
913
  "type": [
1068
- "boolean",
1069
- "null",
1070
- "undefined"
914
+ "boolean"
1071
915
  ]
1072
916
  }
1073
917
  },
@@ -1076,9 +920,7 @@
1076
920
  "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
921
  "value": {
1078
922
  "type": [
1079
- "boolean",
1080
- "null",
1081
- "undefined"
923
+ "boolean"
1082
924
  ]
1083
925
  }
1084
926
  },
@@ -1087,9 +929,7 @@
1087
929
  "description": "Text content to display in the header cell of the column.",
1088
930
  "value": {
1089
931
  "type": [
1090
- "string",
1091
- "null",
1092
- "undefined"
932
+ "string"
1093
933
  ]
1094
934
  }
1095
935
  },
@@ -1098,9 +938,7 @@
1098
938
  "description": "Custom part name for the header cell.",
1099
939
  "value": {
1100
940
  "type": [
1101
- "string",
1102
- "null",
1103
- "undefined"
941
+ "string"
1104
942
  ]
1105
943
  }
1106
944
  },
@@ -1109,9 +947,7 @@
1109
947
  "description": "When set to true, the cells for this column are hidden.",
1110
948
  "value": {
1111
949
  "type": [
1112
- "boolean",
1113
- "null",
1114
- "undefined"
950
+ "boolean"
1115
951
  ]
1116
952
  }
1117
953
  },
@@ -1120,9 +956,7 @@
1120
956
  "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
957
  "value": {
1122
958
  "type": [
1123
- "string",
1124
- "null",
1125
- "undefined"
959
+ "string"
1126
960
  ]
1127
961
  }
1128
962
  },
@@ -1131,9 +965,7 @@
1131
965
  "description": "When set to true, the column is user-resizable.",
1132
966
  "value": {
1133
967
  "type": [
1134
- "boolean",
1135
- "null",
1136
- "undefined"
968
+ "boolean"
1137
969
  ]
1138
970
  }
1139
971
  },
@@ -1142,9 +974,7 @@
1142
974
  "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
975
  "value": {
1144
976
  "type": [
1145
- "boolean",
1146
- "null",
1147
- "undefined"
977
+ "boolean"
1148
978
  ]
1149
979
  }
1150
980
  },
@@ -1153,9 +983,7 @@
1153
983
  "description": "When true, all the items are selected.",
1154
984
  "value": {
1155
985
  "type": [
1156
- "boolean",
1157
- "null",
1158
- "undefined"
986
+ "boolean"
1159
987
  ]
1160
988
  }
1161
989
  },
@@ -1164,9 +992,7 @@
1164
992
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1165
993
  "value": {
1166
994
  "type": [
1167
- "string",
1168
- "null",
1169
- "undefined"
995
+ "string"
1170
996
  ]
1171
997
  }
1172
998
  },
@@ -1186,9 +1012,7 @@
1186
1012
  "description": "Width of the cells for this column.",
1187
1013
  "value": {
1188
1014
  "type": [
1189
- "string",
1190
- "null",
1191
- "undefined"
1015
+ "string"
1192
1016
  ]
1193
1017
  }
1194
1018
  }
@@ -1200,9 +1024,7 @@
1200
1024
  "description": "When true, the active item gets automatically selected.",
1201
1025
  "value": {
1202
1026
  "type": [
1203
- "boolean",
1204
- "null",
1205
- "undefined"
1027
+ "boolean"
1206
1028
  ]
1207
1029
  }
1208
1030
  },
@@ -1211,9 +1033,7 @@
1211
1033
  "description": "Override `autoWidth` to enable auto-width",
1212
1034
  "value": {
1213
1035
  "type": [
1214
- "boolean",
1215
- "null",
1216
- "undefined"
1036
+ "boolean"
1217
1037
  ]
1218
1038
  }
1219
1039
  },
@@ -1222,9 +1042,7 @@
1222
1042
  "description": "When true, rows can be selected by dragging over the selection column.",
1223
1043
  "value": {
1224
1044
  "type": [
1225
- "boolean",
1226
- "null",
1227
- "undefined"
1045
+ "boolean"
1228
1046
  ]
1229
1047
  }
1230
1048
  },
@@ -1233,9 +1051,7 @@
1233
1051
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1234
1052
  "value": {
1235
1053
  "type": [
1236
- "number",
1237
- "null",
1238
- "undefined"
1054
+ "number"
1239
1055
  ]
1240
1056
  }
1241
1057
  },
@@ -1244,9 +1060,7 @@
1244
1060
  "description": "Custom part name for the footer cell.",
1245
1061
  "value": {
1246
1062
  "type": [
1247
- "string",
1248
- "null",
1249
- "undefined"
1063
+ "string"
1250
1064
  ]
1251
1065
  }
1252
1066
  },
@@ -1266,9 +1080,7 @@
1266
1080
  "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
1081
  "value": {
1268
1082
  "type": [
1269
- "boolean",
1270
- "null",
1271
- "undefined"
1083
+ "boolean"
1272
1084
  ]
1273
1085
  }
1274
1086
  },
@@ -1277,9 +1089,7 @@
1277
1089
  "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
1090
  "value": {
1279
1091
  "type": [
1280
- "boolean",
1281
- "null",
1282
- "undefined"
1092
+ "boolean"
1283
1093
  ]
1284
1094
  }
1285
1095
  },
@@ -1288,9 +1098,7 @@
1288
1098
  "description": "Text content to display in the header cell of the column.",
1289
1099
  "value": {
1290
1100
  "type": [
1291
- "string",
1292
- "null",
1293
- "undefined"
1101
+ "string"
1294
1102
  ]
1295
1103
  }
1296
1104
  },
@@ -1299,9 +1107,7 @@
1299
1107
  "description": "Custom part name for the header cell.",
1300
1108
  "value": {
1301
1109
  "type": [
1302
- "string",
1303
- "null",
1304
- "undefined"
1110
+ "string"
1305
1111
  ]
1306
1112
  }
1307
1113
  },
@@ -1321,9 +1127,7 @@
1321
1127
  "description": "When set to true, the cells for this column are hidden.",
1322
1128
  "value": {
1323
1129
  "type": [
1324
- "boolean",
1325
- "null",
1326
- "undefined"
1130
+ "boolean"
1327
1131
  ]
1328
1132
  }
1329
1133
  },
@@ -1332,9 +1136,7 @@
1332
1136
  "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
1137
  "value": {
1334
1138
  "type": [
1335
- "string",
1336
- "null",
1337
- "undefined"
1139
+ "string"
1338
1140
  ]
1339
1141
  }
1340
1142
  },
@@ -1354,9 +1156,7 @@
1354
1156
  "description": "When set to true, the column is user-resizable.",
1355
1157
  "value": {
1356
1158
  "type": [
1357
- "boolean",
1358
- "null",
1359
- "undefined"
1159
+ "boolean"
1360
1160
  ]
1361
1161
  }
1362
1162
  },
@@ -1365,9 +1165,7 @@
1365
1165
  "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
1166
  "value": {
1367
1167
  "type": [
1368
- "boolean",
1369
- "null",
1370
- "undefined"
1168
+ "boolean"
1371
1169
  ]
1372
1170
  }
1373
1171
  },
@@ -1376,9 +1174,7 @@
1376
1174
  "description": "When true, all the items are selected.",
1377
1175
  "value": {
1378
1176
  "type": [
1379
- "boolean",
1380
- "null",
1381
- "undefined"
1177
+ "boolean"
1382
1178
  ]
1383
1179
  }
1384
1180
  },
@@ -1387,9 +1183,7 @@
1387
1183
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1388
1184
  "value": {
1389
1185
  "type": [
1390
- "string",
1391
- "null",
1392
- "undefined"
1186
+ "string"
1393
1187
  ]
1394
1188
  }
1395
1189
  },
@@ -1398,9 +1192,7 @@
1398
1192
  "description": "Width of the cells for this column.",
1399
1193
  "value": {
1400
1194
  "type": [
1401
- "string",
1402
- "null",
1403
- "undefined"
1195
+ "string"
1404
1196
  ]
1405
1197
  }
1406
1198
  }
@@ -1413,77 +1205,6 @@
1413
1205
  ]
1414
1206
  }
1415
1207
  },
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
1208
  {
1488
1209
  "name": "vaadin-grid-sort-column",
1489
1210
  "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 +1214,7 @@
1493
1214
  "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
1215
  "value": {
1495
1216
  "type": [
1496
- "boolean",
1497
- "null",
1498
- "undefined"
1217
+ "boolean"
1499
1218
  ]
1500
1219
  }
1501
1220
  },
@@ -1504,9 +1223,7 @@
1504
1223
  "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
1224
  "value": {
1506
1225
  "type": [
1507
- "string",
1508
- "null",
1509
- "undefined"
1226
+ "string"
1510
1227
  ]
1511
1228
  }
1512
1229
  },
@@ -1515,9 +1232,7 @@
1515
1232
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1516
1233
  "value": {
1517
1234
  "type": [
1518
- "number",
1519
- "null",
1520
- "undefined"
1235
+ "number"
1521
1236
  ]
1522
1237
  }
1523
1238
  },
@@ -1526,9 +1241,7 @@
1526
1241
  "description": "Custom part name for the footer cell.",
1527
1242
  "value": {
1528
1243
  "type": [
1529
- "string",
1530
- "null",
1531
- "undefined"
1244
+ "string"
1532
1245
  ]
1533
1246
  }
1534
1247
  },
@@ -1537,9 +1250,7 @@
1537
1250
  "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
1251
  "value": {
1539
1252
  "type": [
1540
- "boolean",
1541
- "null",
1542
- "undefined"
1253
+ "boolean"
1543
1254
  ]
1544
1255
  }
1545
1256
  },
@@ -1548,9 +1259,7 @@
1548
1259
  "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
1260
  "value": {
1550
1261
  "type": [
1551
- "boolean",
1552
- "null",
1553
- "undefined"
1262
+ "boolean"
1554
1263
  ]
1555
1264
  }
1556
1265
  },
@@ -1559,9 +1268,7 @@
1559
1268
  "description": "Text content to display in the header cell of the column.",
1560
1269
  "value": {
1561
1270
  "type": [
1562
- "string",
1563
- "null",
1564
- "undefined"
1271
+ "string"
1565
1272
  ]
1566
1273
  }
1567
1274
  },
@@ -1570,9 +1277,7 @@
1570
1277
  "description": "Custom part name for the header cell.",
1571
1278
  "value": {
1572
1279
  "type": [
1573
- "string",
1574
- "null",
1575
- "undefined"
1280
+ "string"
1576
1281
  ]
1577
1282
  }
1578
1283
  },
@@ -1581,9 +1286,7 @@
1581
1286
  "description": "When set to true, the cells for this column are hidden.",
1582
1287
  "value": {
1583
1288
  "type": [
1584
- "boolean",
1585
- "null",
1586
- "undefined"
1289
+ "boolean"
1587
1290
  ]
1588
1291
  }
1589
1292
  },
@@ -1592,9 +1295,7 @@
1592
1295
  "description": "JS Path of the property in the item used for sorting the data.",
1593
1296
  "value": {
1594
1297
  "type": [
1595
- "string",
1596
- "null",
1597
- "undefined"
1298
+ "string"
1598
1299
  ]
1599
1300
  }
1600
1301
  },
@@ -1603,9 +1304,7 @@
1603
1304
  "description": "When set to true, the column is user-resizable.",
1604
1305
  "value": {
1605
1306
  "type": [
1606
- "boolean",
1607
- "null",
1608
- "undefined"
1307
+ "boolean"
1609
1308
  ]
1610
1309
  }
1611
1310
  },
@@ -1614,9 +1313,7 @@
1614
1313
  "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
1314
  "value": {
1616
1315
  "type": [
1617
- "boolean",
1618
- "null",
1619
- "undefined"
1316
+ "boolean"
1620
1317
  ]
1621
1318
  }
1622
1319
  },
@@ -1625,9 +1322,7 @@
1625
1322
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1626
1323
  "value": {
1627
1324
  "type": [
1628
- "string",
1629
- "null",
1630
- "undefined"
1325
+ "string"
1631
1326
  ]
1632
1327
  }
1633
1328
  },
@@ -1647,9 +1342,7 @@
1647
1342
  "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
1343
  "value": {
1649
1344
  "type": [
1650
- "string",
1651
- "null",
1652
- "undefined"
1345
+ "string"
1653
1346
  ]
1654
1347
  }
1655
1348
  }
@@ -1661,9 +1354,7 @@
1661
1354
  "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
1355
  "value": {
1663
1356
  "type": [
1664
- "boolean",
1665
- "null",
1666
- "undefined"
1357
+ "boolean"
1667
1358
  ]
1668
1359
  }
1669
1360
  },
@@ -1672,9 +1363,7 @@
1672
1363
  "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
1364
  "value": {
1674
1365
  "type": [
1675
- "string",
1676
- "null",
1677
- "undefined"
1366
+ "string"
1678
1367
  ]
1679
1368
  }
1680
1369
  },
@@ -1683,9 +1372,7 @@
1683
1372
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1684
1373
  "value": {
1685
1374
  "type": [
1686
- "number",
1687
- "null",
1688
- "undefined"
1375
+ "number"
1689
1376
  ]
1690
1377
  }
1691
1378
  },
@@ -1694,9 +1381,7 @@
1694
1381
  "description": "Custom part name for the footer cell.",
1695
1382
  "value": {
1696
1383
  "type": [
1697
- "string",
1698
- "null",
1699
- "undefined"
1384
+ "string"
1700
1385
  ]
1701
1386
  }
1702
1387
  },
@@ -1716,9 +1401,7 @@
1716
1401
  "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
1402
  "value": {
1718
1403
  "type": [
1719
- "boolean",
1720
- "null",
1721
- "undefined"
1404
+ "boolean"
1722
1405
  ]
1723
1406
  }
1724
1407
  },
@@ -1727,9 +1410,7 @@
1727
1410
  "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
1411
  "value": {
1729
1412
  "type": [
1730
- "boolean",
1731
- "null",
1732
- "undefined"
1413
+ "boolean"
1733
1414
  ]
1734
1415
  }
1735
1416
  },
@@ -1738,9 +1419,7 @@
1738
1419
  "description": "Text content to display in the header cell of the column.",
1739
1420
  "value": {
1740
1421
  "type": [
1741
- "string",
1742
- "null",
1743
- "undefined"
1422
+ "string"
1744
1423
  ]
1745
1424
  }
1746
1425
  },
@@ -1749,9 +1428,7 @@
1749
1428
  "description": "Custom part name for the header cell.",
1750
1429
  "value": {
1751
1430
  "type": [
1752
- "string",
1753
- "null",
1754
- "undefined"
1431
+ "string"
1755
1432
  ]
1756
1433
  }
1757
1434
  },
@@ -1771,9 +1448,7 @@
1771
1448
  "description": "When set to true, the cells for this column are hidden.",
1772
1449
  "value": {
1773
1450
  "type": [
1774
- "boolean",
1775
- "null",
1776
- "undefined"
1451
+ "boolean"
1777
1452
  ]
1778
1453
  }
1779
1454
  },
@@ -1782,9 +1457,7 @@
1782
1457
  "description": "JS Path of the property in the item used for sorting the data.",
1783
1458
  "value": {
1784
1459
  "type": [
1785
- "string",
1786
- "null",
1787
- "undefined"
1460
+ "string"
1788
1461
  ]
1789
1462
  }
1790
1463
  },
@@ -1804,9 +1477,7 @@
1804
1477
  "description": "When set to true, the column is user-resizable.",
1805
1478
  "value": {
1806
1479
  "type": [
1807
- "boolean",
1808
- "null",
1809
- "undefined"
1480
+ "boolean"
1810
1481
  ]
1811
1482
  }
1812
1483
  },
@@ -1815,9 +1486,7 @@
1815
1486
  "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
1487
  "value": {
1817
1488
  "type": [
1818
- "boolean",
1819
- "null",
1820
- "undefined"
1489
+ "boolean"
1821
1490
  ]
1822
1491
  }
1823
1492
  },
@@ -1826,9 +1495,7 @@
1826
1495
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1827
1496
  "value": {
1828
1497
  "type": [
1829
- "string",
1830
- "null",
1831
- "undefined"
1498
+ "string"
1832
1499
  ]
1833
1500
  }
1834
1501
  },
@@ -1837,55 +1504,38 @@
1837
1504
  "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
1505
  "value": {
1839
1506
  "type": [
1840
- "string",
1841
- "null",
1842
- "undefined"
1507
+ "string"
1843
1508
  ]
1844
1509
  }
1845
1510
  }
1846
1511
  ],
1847
1512
  "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
- ]
1513
+ {
1514
+ "name": "direction-changed",
1515
+ "description": "Fired when the `direction` property changes."
1868
1516
  }
1869
- },
1517
+ ]
1518
+ }
1519
+ },
1520
+ {
1521
+ "name": "vaadin-grid-sorter",
1522
+ "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",
1523
+ "attributes": [
1870
1524
  {
1871
- "name": "leaf",
1872
- "description": "Hides the toggle icon and disables toggling a tree sublevel.",
1525
+ "name": "direction",
1526
+ "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
1527
  "value": {
1874
1528
  "type": [
1875
- "boolean",
1876
- "null",
1877
- "undefined"
1529
+ "string"
1878
1530
  ]
1879
1531
  }
1880
1532
  },
1881
1533
  {
1882
- "name": "level",
1883
- "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1534
+ "name": "path",
1535
+ "description": "JS Path of the property in the item used for sorting the data.",
1884
1536
  "value": {
1885
1537
  "type": [
1886
- "number",
1887
- "null",
1888
- "undefined"
1538
+ "string"
1889
1539
  ]
1890
1540
  }
1891
1541
  },
@@ -1904,43 +1554,32 @@
1904
1554
  "js": {
1905
1555
  "properties": [
1906
1556
  {
1907
- "name": "expanded",
1908
- "description": "Sublevel toggle state.",
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.",
1557
+ "name": "direction",
1558
+ "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
1559
  "value": {
1921
1560
  "type": [
1922
- "boolean",
1923
- "null",
1924
- "undefined"
1561
+ "string"
1925
1562
  ]
1926
1563
  }
1927
1564
  },
1928
1565
  {
1929
- "name": "level",
1930
- "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1566
+ "name": "path",
1567
+ "description": "JS Path of the property in the item used for sorting the data.",
1931
1568
  "value": {
1932
1569
  "type": [
1933
- "number",
1934
- "null",
1935
- "undefined"
1570
+ "string"
1936
1571
  ]
1937
1572
  }
1938
1573
  }
1939
1574
  ],
1940
1575
  "events": [
1941
1576
  {
1942
- "name": "expanded-changed",
1943
- "description": "Fired when the `expanded` property changes."
1577
+ "name": "direction-changed",
1578
+ "description": "Fired when the `direction` property changes."
1579
+ },
1580
+ {
1581
+ "name": "sorter-changed",
1582
+ "description": "Fired when the `path` or `direction` property changes."
1944
1583
  }
1945
1584
  ]
1946
1585
  }
@@ -1954,9 +1593,7 @@
1954
1593
  "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
1594
  "value": {
1956
1595
  "type": [
1957
- "boolean",
1958
- "null",
1959
- "undefined"
1596
+ "boolean"
1960
1597
  ]
1961
1598
  }
1962
1599
  },
@@ -1965,9 +1602,7 @@
1965
1602
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1966
1603
  "value": {
1967
1604
  "type": [
1968
- "number",
1969
- "null",
1970
- "undefined"
1605
+ "number"
1971
1606
  ]
1972
1607
  }
1973
1608
  },
@@ -1976,9 +1611,7 @@
1976
1611
  "description": "Custom part name for the footer cell.",
1977
1612
  "value": {
1978
1613
  "type": [
1979
- "string",
1980
- "null",
1981
- "undefined"
1614
+ "string"
1982
1615
  ]
1983
1616
  }
1984
1617
  },
@@ -1987,9 +1620,7 @@
1987
1620
  "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
1621
  "value": {
1989
1622
  "type": [
1990
- "boolean",
1991
- "null",
1992
- "undefined"
1623
+ "boolean"
1993
1624
  ]
1994
1625
  }
1995
1626
  },
@@ -1998,9 +1629,7 @@
1998
1629
  "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
1630
  "value": {
2000
1631
  "type": [
2001
- "boolean",
2002
- "null",
2003
- "undefined"
1632
+ "boolean"
2004
1633
  ]
2005
1634
  }
2006
1635
  },
@@ -2009,9 +1638,7 @@
2009
1638
  "description": "Text content to display in the header cell of the column.",
2010
1639
  "value": {
2011
1640
  "type": [
2012
- "string",
2013
- "null",
2014
- "undefined"
1641
+ "string"
2015
1642
  ]
2016
1643
  }
2017
1644
  },
@@ -2020,9 +1647,7 @@
2020
1647
  "description": "Custom part name for the header cell.",
2021
1648
  "value": {
2022
1649
  "type": [
2023
- "string",
2024
- "null",
2025
- "undefined"
1650
+ "string"
2026
1651
  ]
2027
1652
  }
2028
1653
  },
@@ -2031,9 +1656,7 @@
2031
1656
  "description": "When set to true, the cells for this column are hidden.",
2032
1657
  "value": {
2033
1658
  "type": [
2034
- "boolean",
2035
- "null",
2036
- "undefined"
1659
+ "boolean"
2037
1660
  ]
2038
1661
  }
2039
1662
  },
@@ -2042,9 +1665,7 @@
2042
1665
  "description": "JS Path of the property in the item used as text content for the tree toggle.",
2043
1666
  "value": {
2044
1667
  "type": [
2045
- "string",
2046
- "null",
2047
- "undefined"
1668
+ "string"
2048
1669
  ]
2049
1670
  }
2050
1671
  },
@@ -2053,9 +1674,7 @@
2053
1674
  "description": "When set to true, the column is user-resizable.",
2054
1675
  "value": {
2055
1676
  "type": [
2056
- "boolean",
2057
- "null",
2058
- "undefined"
1677
+ "boolean"
2059
1678
  ]
2060
1679
  }
2061
1680
  },
@@ -2064,9 +1683,7 @@
2064
1683
  "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
1684
  "value": {
2066
1685
  "type": [
2067
- "boolean",
2068
- "null",
2069
- "undefined"
1686
+ "boolean"
2070
1687
  ]
2071
1688
  }
2072
1689
  },
@@ -2075,9 +1692,7 @@
2075
1692
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
2076
1693
  "value": {
2077
1694
  "type": [
2078
- "string",
2079
- "null",
2080
- "undefined"
1695
+ "string"
2081
1696
  ]
2082
1697
  }
2083
1698
  },
@@ -2097,9 +1712,7 @@
2097
1712
  "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
1713
  "value": {
2099
1714
  "type": [
2100
- "string",
2101
- "null",
2102
- "undefined"
1715
+ "string"
2103
1716
  ]
2104
1717
  }
2105
1718
  }
@@ -2111,9 +1724,7 @@
2111
1724
  "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
1725
  "value": {
2113
1726
  "type": [
2114
- "boolean",
2115
- "null",
2116
- "undefined"
1727
+ "boolean"
2117
1728
  ]
2118
1729
  }
2119
1730
  },
@@ -2122,9 +1733,7 @@
2122
1733
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
2123
1734
  "value": {
2124
1735
  "type": [
2125
- "number",
2126
- "null",
2127
- "undefined"
1736
+ "number"
2128
1737
  ]
2129
1738
  }
2130
1739
  },
@@ -2133,9 +1742,7 @@
2133
1742
  "description": "Custom part name for the footer cell.",
2134
1743
  "value": {
2135
1744
  "type": [
2136
- "string",
2137
- "null",
2138
- "undefined"
1745
+ "string"
2139
1746
  ]
2140
1747
  }
2141
1748
  },
@@ -2155,9 +1762,7 @@
2155
1762
  "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
1763
  "value": {
2157
1764
  "type": [
2158
- "boolean",
2159
- "null",
2160
- "undefined"
1765
+ "boolean"
2161
1766
  ]
2162
1767
  }
2163
1768
  },
@@ -2166,9 +1771,7 @@
2166
1771
  "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
1772
  "value": {
2168
1773
  "type": [
2169
- "boolean",
2170
- "null",
2171
- "undefined"
1774
+ "boolean"
2172
1775
  ]
2173
1776
  }
2174
1777
  },
@@ -2177,9 +1780,7 @@
2177
1780
  "description": "Text content to display in the header cell of the column.",
2178
1781
  "value": {
2179
1782
  "type": [
2180
- "string",
2181
- "null",
2182
- "undefined"
1783
+ "string"
2183
1784
  ]
2184
1785
  }
2185
1786
  },
@@ -2188,9 +1789,7 @@
2188
1789
  "description": "Custom part name for the header cell.",
2189
1790
  "value": {
2190
1791
  "type": [
2191
- "string",
2192
- "null",
2193
- "undefined"
1792
+ "string"
2194
1793
  ]
2195
1794
  }
2196
1795
  },
@@ -2210,9 +1809,7 @@
2210
1809
  "description": "When set to true, the cells for this column are hidden.",
2211
1810
  "value": {
2212
1811
  "type": [
2213
- "boolean",
2214
- "null",
2215
- "undefined"
1812
+ "boolean"
2216
1813
  ]
2217
1814
  }
2218
1815
  },
@@ -2221,9 +1818,7 @@
2221
1818
  "description": "JS Path of the property in the item used as text content for the tree toggle.",
2222
1819
  "value": {
2223
1820
  "type": [
2224
- "string",
2225
- "null",
2226
- "undefined"
1821
+ "string"
2227
1822
  ]
2228
1823
  }
2229
1824
  },
@@ -2243,9 +1838,7 @@
2243
1838
  "description": "When set to true, the column is user-resizable.",
2244
1839
  "value": {
2245
1840
  "type": [
2246
- "boolean",
2247
- "null",
2248
- "undefined"
1841
+ "boolean"
2249
1842
  ]
2250
1843
  }
2251
1844
  },
@@ -2254,9 +1847,7 @@
2254
1847
  "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
1848
  "value": {
2256
1849
  "type": [
2257
- "boolean",
2258
- "null",
2259
- "undefined"
1850
+ "boolean"
2260
1851
  ]
2261
1852
  }
2262
1853
  },
@@ -2265,9 +1856,7 @@
2265
1856
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
2266
1857
  "value": {
2267
1858
  "type": [
2268
- "string",
2269
- "null",
2270
- "undefined"
1859
+ "string"
2271
1860
  ]
2272
1861
  }
2273
1862
  },
@@ -2276,9 +1865,7 @@
2276
1865
  "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
1866
  "value": {
2278
1867
  "type": [
2279
- "string",
2280
- "null",
2281
- "undefined"
1868
+ "string"
2282
1869
  ]
2283
1870
  }
2284
1871
  }
@@ -2287,12 +1874,39 @@
2287
1874
  }
2288
1875
  },
2289
1876
  {
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-alpha1/#/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-alpha1/#/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-alpha1/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha1/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha1/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha1/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha1/#/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-alpha1/#/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-alpha1/#/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.",
1877
+ "name": "vaadin-grid-tree-toggle",
1878
+ "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
1879
  "attributes": [
2293
1880
  {
2294
- "name": "accessible-name",
2295
- "description": "String used to label the grid to screen reader users.",
1881
+ "name": "expanded",
1882
+ "description": "Sublevel toggle state.",
1883
+ "value": {
1884
+ "type": [
1885
+ "boolean"
1886
+ ]
1887
+ }
1888
+ },
1889
+ {
1890
+ "name": "leaf",
1891
+ "description": "Hides the toggle icon and disables toggling a tree sublevel.",
1892
+ "value": {
1893
+ "type": [
1894
+ "boolean"
1895
+ ]
1896
+ }
1897
+ },
1898
+ {
1899
+ "name": "level",
1900
+ "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1901
+ "value": {
1902
+ "type": [
1903
+ "number"
1904
+ ]
1905
+ }
1906
+ },
1907
+ {
1908
+ "name": "theme",
1909
+ "description": "The theme variants to apply to the component.",
2296
1910
  "value": {
2297
1911
  "type": [
2298
1912
  "string",
@@ -2300,15 +1914,65 @@
2300
1914
  "undefined"
2301
1915
  ]
2302
1916
  }
1917
+ }
1918
+ ],
1919
+ "js": {
1920
+ "properties": [
1921
+ {
1922
+ "name": "expanded",
1923
+ "description": "Sublevel toggle state.",
1924
+ "value": {
1925
+ "type": [
1926
+ "boolean"
1927
+ ]
1928
+ }
1929
+ },
1930
+ {
1931
+ "name": "leaf",
1932
+ "description": "Hides the toggle icon and disables toggling a tree sublevel.",
1933
+ "value": {
1934
+ "type": [
1935
+ "boolean"
1936
+ ]
1937
+ }
1938
+ },
1939
+ {
1940
+ "name": "level",
1941
+ "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1942
+ "value": {
1943
+ "type": [
1944
+ "number"
1945
+ ]
1946
+ }
1947
+ }
1948
+ ],
1949
+ "events": [
1950
+ {
1951
+ "name": "expanded-changed",
1952
+ "description": "Fired when the `expanded` property changes."
1953
+ }
1954
+ ]
1955
+ }
1956
+ },
1957
+ {
1958
+ "name": "vaadin-grid",
1959
+ "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-alpha10/#/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-alpha10/#/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-alpha10/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.2.0-alpha10/#/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-alpha10/#/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-alpha10/#/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.",
1960
+ "attributes": [
1961
+ {
1962
+ "name": "accessible-name",
1963
+ "description": "String used to label the grid to screen reader users.",
1964
+ "value": {
1965
+ "type": [
1966
+ "string"
1967
+ ]
1968
+ }
2303
1969
  },
2304
1970
  {
2305
1971
  "name": "all-rows-visible",
2306
1972
  "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
1973
  "value": {
2308
1974
  "type": [
2309
- "boolean",
2310
- "null",
2311
- "undefined"
1975
+ "boolean"
2312
1976
  ]
2313
1977
  }
2314
1978
  },
@@ -2317,9 +1981,7 @@
2317
1981
  "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
1982
  "value": {
2319
1983
  "type": [
2320
- "string",
2321
- "null",
2322
- "undefined"
1984
+ "string"
2323
1985
  ]
2324
1986
  }
2325
1987
  },
@@ -2328,9 +1990,16 @@
2328
1990
  "description": "Set to true to allow column reordering.",
2329
1991
  "value": {
2330
1992
  "type": [
2331
- "boolean",
2332
- "null",
2333
- "undefined"
1993
+ "boolean"
1994
+ ]
1995
+ }
1996
+ },
1997
+ {
1998
+ "name": "disabled",
1999
+ "description": "If true, the user cannot interact with this element.",
2000
+ "value": {
2001
+ "type": [
2002
+ "boolean"
2334
2003
  ]
2335
2004
  }
2336
2005
  },
@@ -2339,9 +2008,7 @@
2339
2008
  "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
2009
  "value": {
2341
2010
  "type": [
2342
- "string",
2343
- "null",
2344
- "undefined"
2011
+ "string"
2345
2012
  ]
2346
2013
  }
2347
2014
  },
@@ -2350,9 +2017,7 @@
2350
2017
  "description": "Path to an item sub-property that indicates whether the item has child items.",
2351
2018
  "value": {
2352
2019
  "type": [
2353
- "string",
2354
- "null",
2355
- "undefined"
2020
+ "string"
2356
2021
  ]
2357
2022
  }
2358
2023
  },
@@ -2361,9 +2026,7 @@
2361
2026
  "description": "Path to an item sub-property that identifies the item.",
2362
2027
  "value": {
2363
2028
  "type": [
2364
- "string",
2365
- "null",
2366
- "undefined"
2029
+ "string"
2367
2030
  ]
2368
2031
  }
2369
2032
  },
@@ -2372,9 +2035,7 @@
2372
2035
  "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
2373
2036
  "value": {
2374
2037
  "type": [
2375
- "boolean",
2376
- "null",
2377
- "undefined"
2038
+ "boolean"
2378
2039
  ]
2379
2040
  }
2380
2041
  },
@@ -2383,9 +2044,7 @@
2383
2044
  "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
2045
  "value": {
2385
2046
  "type": [
2386
- "boolean",
2387
- "null",
2388
- "undefined"
2047
+ "boolean"
2389
2048
  ]
2390
2049
  }
2391
2050
  },
@@ -2394,9 +2053,7 @@
2394
2053
  "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
2054
  "value": {
2396
2055
  "type": [
2397
- "string",
2398
- "null",
2399
- "undefined"
2056
+ "string"
2400
2057
  ]
2401
2058
  }
2402
2059
  },
@@ -2405,9 +2062,7 @@
2405
2062
  "description": "Number of items fetched at a time from the dataprovider.",
2406
2063
  "value": {
2407
2064
  "type": [
2408
- "number",
2409
- "null",
2410
- "undefined"
2065
+ "number"
2411
2066
  ]
2412
2067
  }
2413
2068
  },
@@ -2416,9 +2071,7 @@
2416
2071
  "description": "Marks the grid's rows to be available for dragging.",
2417
2072
  "value": {
2418
2073
  "type": [
2419
- "boolean",
2420
- "null",
2421
- "undefined"
2074
+ "boolean"
2422
2075
  ]
2423
2076
  }
2424
2077
  },
@@ -2427,9 +2080,7 @@
2427
2080
  "description": "The number of root-level items in the grid.",
2428
2081
  "value": {
2429
2082
  "type": [
2430
- "number",
2431
- "null",
2432
- "undefined"
2083
+ "number"
2433
2084
  ]
2434
2085
  }
2435
2086
  },
@@ -2452,9 +2103,7 @@
2452
2103
  "description": "String used to label the grid to screen reader users.",
2453
2104
  "value": {
2454
2105
  "type": [
2455
- "string",
2456
- "null",
2457
- "undefined"
2106
+ "string"
2458
2107
  ]
2459
2108
  }
2460
2109
  },
@@ -2472,9 +2121,7 @@
2472
2121
  "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
2122
  "value": {
2474
2123
  "type": [
2475
- "boolean",
2476
- "null",
2477
- "undefined"
2124
+ "boolean"
2478
2125
  ]
2479
2126
  }
2480
2127
  },
@@ -2494,9 +2141,7 @@
2494
2141
  "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
2142
  "value": {
2496
2143
  "type": [
2497
- "string",
2498
- "null",
2499
- "undefined"
2144
+ "string"
2500
2145
  ]
2501
2146
  }
2502
2147
  },
@@ -2505,9 +2150,7 @@
2505
2150
  "description": "Set to true to allow column reordering.",
2506
2151
  "value": {
2507
2152
  "type": [
2508
- "boolean",
2509
- "null",
2510
- "undefined"
2153
+ "boolean"
2511
2154
  ]
2512
2155
  }
2513
2156
  },
@@ -2527,7 +2170,16 @@
2527
2170
  "description": "An array containing references to items with open row details.",
2528
2171
  "value": {
2529
2172
  "type": [
2530
- "Array.<GridItem>"
2173
+ "Array<GridItem>"
2174
+ ]
2175
+ }
2176
+ },
2177
+ {
2178
+ "name": "disabled",
2179
+ "description": "If true, the user cannot interact with this element.",
2180
+ "value": {
2181
+ "type": [
2182
+ "boolean"
2531
2183
  ]
2532
2184
  }
2533
2185
  },
@@ -2558,9 +2210,7 @@
2558
2210
  "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
2211
  "value": {
2560
2212
  "type": [
2561
- "string",
2562
- "null",
2563
- "undefined"
2213
+ "string"
2564
2214
  ]
2565
2215
  }
2566
2216
  },
@@ -2569,7 +2219,7 @@
2569
2219
  "description": "An array that contains the expanded items.",
2570
2220
  "value": {
2571
2221
  "type": [
2572
- "Array.<GridItem>"
2222
+ "Array<GridItem>"
2573
2223
  ]
2574
2224
  }
2575
2225
  },
@@ -2578,9 +2228,7 @@
2578
2228
  "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
2229
  "value": {
2580
2230
  "type": [
2581
- "Function",
2582
- "null",
2583
- "undefined"
2231
+ "item: GridItem => boolean"
2584
2232
  ]
2585
2233
  }
2586
2234
  },
@@ -2589,9 +2237,7 @@
2589
2237
  "description": "Path to an item sub-property that indicates whether the item has child items.",
2590
2238
  "value": {
2591
2239
  "type": [
2592
- "string",
2593
- "null",
2594
- "undefined"
2240
+ "string"
2595
2241
  ]
2596
2242
  }
2597
2243
  },
@@ -2600,9 +2246,7 @@
2600
2246
  "description": "Path to an item sub-property that identifies the item.",
2601
2247
  "value": {
2602
2248
  "type": [
2603
- "string",
2604
- "null",
2605
- "undefined"
2249
+ "string"
2606
2250
  ]
2607
2251
  }
2608
2252
  },
@@ -2611,7 +2255,7 @@
2611
2255
  "description": "An array containing the items which will be passed to renderer functions.",
2612
2256
  "value": {
2613
2257
  "type": [
2614
- "Array.<GridItem>",
2258
+ "Array<GridItem>",
2615
2259
  "undefined"
2616
2260
  ]
2617
2261
  }
@@ -2621,9 +2265,7 @@
2621
2265
  "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
2622
2266
  "value": {
2623
2267
  "type": [
2624
- "boolean",
2625
- "null",
2626
- "undefined"
2268
+ "boolean"
2627
2269
  ]
2628
2270
  }
2629
2271
  },
@@ -2632,9 +2274,7 @@
2632
2274
  "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
2275
  "value": {
2634
2276
  "type": [
2635
- "boolean",
2636
- "null",
2637
- "undefined"
2277
+ "boolean"
2638
2278
  ]
2639
2279
  }
2640
2280
  },
@@ -2643,9 +2283,7 @@
2643
2283
  "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
2284
  "value": {
2645
2285
  "type": [
2646
- "string",
2647
- "null",
2648
- "undefined"
2286
+ "string"
2649
2287
  ]
2650
2288
  }
2651
2289
  },
@@ -2654,9 +2292,7 @@
2654
2292
  "description": "Number of items fetched at a time from the dataprovider.",
2655
2293
  "value": {
2656
2294
  "type": [
2657
- "number",
2658
- "null",
2659
- "undefined"
2295
+ "number"
2660
2296
  ]
2661
2297
  }
2662
2298
  },
@@ -2676,9 +2312,7 @@
2676
2312
  "description": "Marks the grid's rows to be available for dragging.",
2677
2313
  "value": {
2678
2314
  "type": [
2679
- "boolean",
2680
- "null",
2681
- "undefined"
2315
+ "boolean"
2682
2316
  ]
2683
2317
  }
2684
2318
  },
@@ -2687,7 +2321,7 @@
2687
2321
  "description": "An array that contains the selected items.",
2688
2322
  "value": {
2689
2323
  "type": [
2690
- "Array.<GridItem>"
2324
+ "Array<GridItem>"
2691
2325
  ]
2692
2326
  }
2693
2327
  },
@@ -2696,9 +2330,7 @@
2696
2330
  "description": "The number of root-level items in the grid.",
2697
2331
  "value": {
2698
2332
  "type": [
2699
- "number",
2700
- "null",
2701
- "undefined"
2333
+ "number"
2702
2334
  ]
2703
2335
  }
2704
2336
  }
@@ -2714,7 +2346,7 @@
2714
2346
  },
2715
2347
  {
2716
2348
  "name": "cell-focus",
2717
- "description": "Fired when a cell is focused with click or keyboard navigation.\n\nUse context property of @see {@link GridCellFocusEvent} to get detail information about the event."
2349
+ "description": "Fired when a cell is focused with click or keyboard navigation. Use the `context` property to read event details."
2718
2350
  },
2719
2351
  {
2720
2352
  "name": "column-reorder",
@@ -2722,7 +2354,7 @@
2722
2354
  },
2723
2355
  {
2724
2356
  "name": "column-resize",
2725
- "description": "Fired when a column in the grid is resized by the user."
2357
+ "description": "Fired when the grid column resize is finished."
2726
2358
  },
2727
2359
  {
2728
2360
  "name": "data-provider-changed",