@vaadin/grid 25.1.0-beta1 → 25.1.0-beta3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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.1.0-beta1",
4
+ "version": "25.1.0-beta3",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -26,7 +26,9 @@
26
26
  "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
27
  "value": {
28
28
  "type": [
29
- "boolean"
29
+ "boolean",
30
+ "null",
31
+ "undefined"
30
32
  ]
31
33
  }
32
34
  },
@@ -35,7 +37,9 @@
35
37
  "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.",
36
38
  "value": {
37
39
  "type": [
38
- "boolean"
40
+ "boolean",
41
+ "null",
42
+ "undefined"
39
43
  ]
40
44
  }
41
45
  },
@@ -88,7 +92,9 @@
88
92
  "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.",
89
93
  "value": {
90
94
  "type": [
91
- "boolean"
95
+ "boolean",
96
+ "null",
97
+ "undefined"
92
98
  ]
93
99
  }
94
100
  },
@@ -97,7 +103,7 @@
97
103
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
98
104
  "value": {
99
105
  "type": [
100
- "GridColumnTextAlign",
106
+ "string",
101
107
  "null",
102
108
  "undefined"
103
109
  ]
@@ -144,7 +150,9 @@
144
150
  "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.",
145
151
  "value": {
146
152
  "type": [
147
- "boolean"
153
+ "boolean",
154
+ "null",
155
+ "undefined"
148
156
  ]
149
157
  }
150
158
  },
@@ -153,7 +161,9 @@
153
161
  "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.",
154
162
  "value": {
155
163
  "type": [
156
- "boolean"
164
+ "boolean",
165
+ "null",
166
+ "undefined"
157
167
  ]
158
168
  }
159
169
  },
@@ -217,7 +227,9 @@
217
227
  "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.",
218
228
  "value": {
219
229
  "type": [
220
- "boolean"
230
+ "boolean",
231
+ "null",
232
+ "undefined"
221
233
  ]
222
234
  }
223
235
  },
@@ -226,7 +238,7 @@
226
238
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
227
239
  "value": {
228
240
  "type": [
229
- "GridColumnTextAlign",
241
+ "string",
230
242
  "null",
231
243
  "undefined"
232
244
  ]
@@ -238,14 +250,16 @@
238
250
  },
239
251
  {
240
252
  "name": "vaadin-grid-column",
241
- "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.1.0-beta1/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<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.1.0-beta3/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
242
254
  "attributes": [
243
255
  {
244
256
  "name": "auto-width",
245
257
  "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.",
246
258
  "value": {
247
259
  "type": [
248
- "boolean"
260
+ "boolean",
261
+ "null",
262
+ "undefined"
249
263
  ]
250
264
  }
251
265
  },
@@ -254,7 +268,9 @@
254
268
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
255
269
  "value": {
256
270
  "type": [
257
- "number"
271
+ "number",
272
+ "null",
273
+ "undefined"
258
274
  ]
259
275
  }
260
276
  },
@@ -274,7 +290,9 @@
274
290
  "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.",
275
291
  "value": {
276
292
  "type": [
277
- "boolean"
293
+ "boolean",
294
+ "null",
295
+ "undefined"
278
296
  ]
279
297
  }
280
298
  },
@@ -283,7 +301,9 @@
283
301
  "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.",
284
302
  "value": {
285
303
  "type": [
286
- "boolean"
304
+ "boolean",
305
+ "null",
306
+ "undefined"
287
307
  ]
288
308
  }
289
309
  },
@@ -347,7 +367,9 @@
347
367
  "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.",
348
368
  "value": {
349
369
  "type": [
350
- "boolean"
370
+ "boolean",
371
+ "null",
372
+ "undefined"
351
373
  ]
352
374
  }
353
375
  },
@@ -356,7 +378,7 @@
356
378
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
357
379
  "value": {
358
380
  "type": [
359
- "GridColumnTextAlign",
381
+ "string",
360
382
  "null",
361
383
  "undefined"
362
384
  ]
@@ -392,7 +414,9 @@
392
414
  "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.",
393
415
  "value": {
394
416
  "type": [
395
- "boolean"
417
+ "boolean",
418
+ "null",
419
+ "undefined"
396
420
  ]
397
421
  }
398
422
  },
@@ -401,7 +425,9 @@
401
425
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
402
426
  "value": {
403
427
  "type": [
404
- "number"
428
+ "number",
429
+ "null",
430
+ "undefined"
405
431
  ]
406
432
  }
407
433
  },
@@ -432,7 +458,9 @@
432
458
  "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.",
433
459
  "value": {
434
460
  "type": [
435
- "boolean"
461
+ "boolean",
462
+ "null",
463
+ "undefined"
436
464
  ]
437
465
  }
438
466
  },
@@ -441,7 +469,9 @@
441
469
  "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.",
442
470
  "value": {
443
471
  "type": [
444
- "boolean"
472
+ "boolean",
473
+ "null",
474
+ "undefined"
445
475
  ]
446
476
  }
447
477
  },
@@ -527,7 +557,9 @@
527
557
  "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.",
528
558
  "value": {
529
559
  "type": [
530
- "boolean"
560
+ "boolean",
561
+ "null",
562
+ "undefined"
531
563
  ]
532
564
  }
533
565
  },
@@ -536,7 +568,7 @@
536
568
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
537
569
  "value": {
538
570
  "type": [
539
- "GridColumnTextAlign",
571
+ "string",
540
572
  "null",
541
573
  "undefined"
542
574
  ]
@@ -637,7 +669,9 @@
637
669
  "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.",
638
670
  "value": {
639
671
  "type": [
640
- "boolean"
672
+ "boolean",
673
+ "null",
674
+ "undefined"
641
675
  ]
642
676
  }
643
677
  },
@@ -646,7 +680,9 @@
646
680
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
647
681
  "value": {
648
682
  "type": [
649
- "number"
683
+ "number",
684
+ "null",
685
+ "undefined"
650
686
  ]
651
687
  }
652
688
  },
@@ -666,7 +702,9 @@
666
702
  "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.",
667
703
  "value": {
668
704
  "type": [
669
- "boolean"
705
+ "boolean",
706
+ "null",
707
+ "undefined"
670
708
  ]
671
709
  }
672
710
  },
@@ -675,7 +713,9 @@
675
713
  "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.",
676
714
  "value": {
677
715
  "type": [
678
- "boolean"
716
+ "boolean",
717
+ "null",
718
+ "undefined"
679
719
  ]
680
720
  }
681
721
  },
@@ -739,7 +779,9 @@
739
779
  "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.",
740
780
  "value": {
741
781
  "type": [
742
- "boolean"
782
+ "boolean",
783
+ "null",
784
+ "undefined"
743
785
  ]
744
786
  }
745
787
  },
@@ -748,7 +790,7 @@
748
790
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
749
791
  "value": {
750
792
  "type": [
751
- "GridColumnTextAlign",
793
+ "string",
752
794
  "null",
753
795
  "undefined"
754
796
  ]
@@ -784,7 +826,9 @@
784
826
  "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.",
785
827
  "value": {
786
828
  "type": [
787
- "boolean"
829
+ "boolean",
830
+ "null",
831
+ "undefined"
788
832
  ]
789
833
  }
790
834
  },
@@ -793,7 +837,9 @@
793
837
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
794
838
  "value": {
795
839
  "type": [
796
- "number"
840
+ "number",
841
+ "null",
842
+ "undefined"
797
843
  ]
798
844
  }
799
845
  },
@@ -824,7 +870,9 @@
824
870
  "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.",
825
871
  "value": {
826
872
  "type": [
827
- "boolean"
873
+ "boolean",
874
+ "null",
875
+ "undefined"
828
876
  ]
829
877
  }
830
878
  },
@@ -833,7 +881,9 @@
833
881
  "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.",
834
882
  "value": {
835
883
  "type": [
836
- "boolean"
884
+ "boolean",
885
+ "null",
886
+ "undefined"
837
887
  ]
838
888
  }
839
889
  },
@@ -919,7 +969,9 @@
919
969
  "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.",
920
970
  "value": {
921
971
  "type": [
922
- "boolean"
972
+ "boolean",
973
+ "null",
974
+ "undefined"
923
975
  ]
924
976
  }
925
977
  },
@@ -928,7 +980,7 @@
928
980
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
929
981
  "value": {
930
982
  "type": [
931
- "GridColumnTextAlign",
983
+ "string",
932
984
  "null",
933
985
  "undefined"
934
986
  ]
@@ -951,14 +1003,16 @@
951
1003
  },
952
1004
  {
953
1005
  "name": "vaadin-grid-selection-column",
954
- "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.1.0-beta1/#/elements/vaadin-grid#property-items),\nthe column header gets an additional checkbox that can be used for toggling\nselection for all the items at once.\n\n__The default content can also be overridden__",
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.1.0-beta3/#/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__",
955
1007
  "attributes": [
956
1008
  {
957
1009
  "name": "auto-select",
958
1010
  "description": "When true, the active item gets automatically selected.",
959
1011
  "value": {
960
1012
  "type": [
961
- "boolean"
1013
+ "boolean",
1014
+ "null",
1015
+ "undefined"
962
1016
  ]
963
1017
  }
964
1018
  },
@@ -978,7 +1032,9 @@
978
1032
  "description": "When true, rows can be selected by dragging over the selection column.",
979
1033
  "value": {
980
1034
  "type": [
981
- "boolean"
1035
+ "boolean",
1036
+ "null",
1037
+ "undefined"
982
1038
  ]
983
1039
  }
984
1040
  },
@@ -987,7 +1043,9 @@
987
1043
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
988
1044
  "value": {
989
1045
  "type": [
990
- "number"
1046
+ "number",
1047
+ "null",
1048
+ "undefined"
991
1049
  ]
992
1050
  }
993
1051
  },
@@ -1007,7 +1065,9 @@
1007
1065
  "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.",
1008
1066
  "value": {
1009
1067
  "type": [
1010
- "boolean"
1068
+ "boolean",
1069
+ "null",
1070
+ "undefined"
1011
1071
  ]
1012
1072
  }
1013
1073
  },
@@ -1016,7 +1076,9 @@
1016
1076
  "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.",
1017
1077
  "value": {
1018
1078
  "type": [
1019
- "boolean"
1079
+ "boolean",
1080
+ "null",
1081
+ "undefined"
1020
1082
  ]
1021
1083
  }
1022
1084
  },
@@ -1080,7 +1142,9 @@
1080
1142
  "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.",
1081
1143
  "value": {
1082
1144
  "type": [
1083
- "boolean"
1145
+ "boolean",
1146
+ "null",
1147
+ "undefined"
1084
1148
  ]
1085
1149
  }
1086
1150
  },
@@ -1089,7 +1153,9 @@
1089
1153
  "description": "When true, all the items are selected.",
1090
1154
  "value": {
1091
1155
  "type": [
1092
- "boolean"
1156
+ "boolean",
1157
+ "null",
1158
+ "undefined"
1093
1159
  ]
1094
1160
  }
1095
1161
  },
@@ -1098,7 +1164,7 @@
1098
1164
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1099
1165
  "value": {
1100
1166
  "type": [
1101
- "GridColumnTextAlign",
1167
+ "string",
1102
1168
  "null",
1103
1169
  "undefined"
1104
1170
  ]
@@ -1134,7 +1200,9 @@
1134
1200
  "description": "When true, the active item gets automatically selected.",
1135
1201
  "value": {
1136
1202
  "type": [
1137
- "boolean"
1203
+ "boolean",
1204
+ "null",
1205
+ "undefined"
1138
1206
  ]
1139
1207
  }
1140
1208
  },
@@ -1154,7 +1222,9 @@
1154
1222
  "description": "When true, rows can be selected by dragging over the selection column.",
1155
1223
  "value": {
1156
1224
  "type": [
1157
- "boolean"
1225
+ "boolean",
1226
+ "null",
1227
+ "undefined"
1158
1228
  ]
1159
1229
  }
1160
1230
  },
@@ -1163,7 +1233,9 @@
1163
1233
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1164
1234
  "value": {
1165
1235
  "type": [
1166
- "number"
1236
+ "number",
1237
+ "null",
1238
+ "undefined"
1167
1239
  ]
1168
1240
  }
1169
1241
  },
@@ -1194,7 +1266,9 @@
1194
1266
  "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.",
1195
1267
  "value": {
1196
1268
  "type": [
1197
- "boolean"
1269
+ "boolean",
1270
+ "null",
1271
+ "undefined"
1198
1272
  ]
1199
1273
  }
1200
1274
  },
@@ -1203,7 +1277,9 @@
1203
1277
  "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.",
1204
1278
  "value": {
1205
1279
  "type": [
1206
- "boolean"
1280
+ "boolean",
1281
+ "null",
1282
+ "undefined"
1207
1283
  ]
1208
1284
  }
1209
1285
  },
@@ -1289,7 +1365,9 @@
1289
1365
  "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.",
1290
1366
  "value": {
1291
1367
  "type": [
1292
- "boolean"
1368
+ "boolean",
1369
+ "null",
1370
+ "undefined"
1293
1371
  ]
1294
1372
  }
1295
1373
  },
@@ -1298,7 +1376,9 @@
1298
1376
  "description": "When true, all the items are selected.",
1299
1377
  "value": {
1300
1378
  "type": [
1301
- "boolean"
1379
+ "boolean",
1380
+ "null",
1381
+ "undefined"
1302
1382
  ]
1303
1383
  }
1304
1384
  },
@@ -1307,7 +1387,7 @@
1307
1387
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1308
1388
  "value": {
1309
1389
  "type": [
1310
- "GridColumnTextAlign",
1390
+ "string",
1311
1391
  "null",
1312
1392
  "undefined"
1313
1393
  ]
@@ -1342,7 +1422,8 @@
1342
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.",
1343
1423
  "value": {
1344
1424
  "type": [
1345
- "GridSorterDirection",
1425
+ "string",
1426
+ "null",
1346
1427
  "undefined"
1347
1428
  ]
1348
1429
  }
@@ -1377,7 +1458,8 @@
1377
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.",
1378
1459
  "value": {
1379
1460
  "type": [
1380
- "GridSorterDirection",
1461
+ "string",
1462
+ "null",
1381
1463
  "undefined"
1382
1464
  ]
1383
1465
  }
@@ -1411,7 +1493,9 @@
1411
1493
  "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.",
1412
1494
  "value": {
1413
1495
  "type": [
1414
- "boolean"
1496
+ "boolean",
1497
+ "null",
1498
+ "undefined"
1415
1499
  ]
1416
1500
  }
1417
1501
  },
@@ -1420,7 +1504,8 @@
1420
1504
  "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.",
1421
1505
  "value": {
1422
1506
  "type": [
1423
- "GridSorterDirection",
1507
+ "string",
1508
+ "null",
1424
1509
  "undefined"
1425
1510
  ]
1426
1511
  }
@@ -1430,7 +1515,9 @@
1430
1515
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1431
1516
  "value": {
1432
1517
  "type": [
1433
- "number"
1518
+ "number",
1519
+ "null",
1520
+ "undefined"
1434
1521
  ]
1435
1522
  }
1436
1523
  },
@@ -1450,7 +1537,9 @@
1450
1537
  "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.",
1451
1538
  "value": {
1452
1539
  "type": [
1453
- "boolean"
1540
+ "boolean",
1541
+ "null",
1542
+ "undefined"
1454
1543
  ]
1455
1544
  }
1456
1545
  },
@@ -1459,7 +1548,9 @@
1459
1548
  "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.",
1460
1549
  "value": {
1461
1550
  "type": [
1462
- "boolean"
1551
+ "boolean",
1552
+ "null",
1553
+ "undefined"
1463
1554
  ]
1464
1555
  }
1465
1556
  },
@@ -1523,7 +1614,9 @@
1523
1614
  "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.",
1524
1615
  "value": {
1525
1616
  "type": [
1526
- "boolean"
1617
+ "boolean",
1618
+ "null",
1619
+ "undefined"
1527
1620
  ]
1528
1621
  }
1529
1622
  },
@@ -1532,7 +1625,7 @@
1532
1625
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1533
1626
  "value": {
1534
1627
  "type": [
1535
- "GridColumnTextAlign",
1628
+ "string",
1536
1629
  "null",
1537
1630
  "undefined"
1538
1631
  ]
@@ -1568,7 +1661,9 @@
1568
1661
  "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.",
1569
1662
  "value": {
1570
1663
  "type": [
1571
- "boolean"
1664
+ "boolean",
1665
+ "null",
1666
+ "undefined"
1572
1667
  ]
1573
1668
  }
1574
1669
  },
@@ -1577,7 +1672,8 @@
1577
1672
  "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.",
1578
1673
  "value": {
1579
1674
  "type": [
1580
- "GridSorterDirection",
1675
+ "string",
1676
+ "null",
1581
1677
  "undefined"
1582
1678
  ]
1583
1679
  }
@@ -1587,7 +1683,9 @@
1587
1683
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1588
1684
  "value": {
1589
1685
  "type": [
1590
- "number"
1686
+ "number",
1687
+ "null",
1688
+ "undefined"
1591
1689
  ]
1592
1690
  }
1593
1691
  },
@@ -1618,7 +1716,9 @@
1618
1716
  "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.",
1619
1717
  "value": {
1620
1718
  "type": [
1621
- "boolean"
1719
+ "boolean",
1720
+ "null",
1721
+ "undefined"
1622
1722
  ]
1623
1723
  }
1624
1724
  },
@@ -1627,7 +1727,9 @@
1627
1727
  "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.",
1628
1728
  "value": {
1629
1729
  "type": [
1630
- "boolean"
1730
+ "boolean",
1731
+ "null",
1732
+ "undefined"
1631
1733
  ]
1632
1734
  }
1633
1735
  },
@@ -1713,7 +1815,9 @@
1713
1815
  "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.",
1714
1816
  "value": {
1715
1817
  "type": [
1716
- "boolean"
1818
+ "boolean",
1819
+ "null",
1820
+ "undefined"
1717
1821
  ]
1718
1822
  }
1719
1823
  },
@@ -1722,7 +1826,7 @@
1722
1826
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1723
1827
  "value": {
1724
1828
  "type": [
1725
- "GridColumnTextAlign",
1829
+ "string",
1726
1830
  "null",
1727
1831
  "undefined"
1728
1832
  ]
@@ -1757,7 +1861,9 @@
1757
1861
  "description": "Sublevel toggle state.",
1758
1862
  "value": {
1759
1863
  "type": [
1760
- "boolean"
1864
+ "boolean",
1865
+ "null",
1866
+ "undefined"
1761
1867
  ]
1762
1868
  }
1763
1869
  },
@@ -1766,7 +1872,9 @@
1766
1872
  "description": "Hides the toggle icon and disables toggling a tree sublevel.",
1767
1873
  "value": {
1768
1874
  "type": [
1769
- "boolean"
1875
+ "boolean",
1876
+ "null",
1877
+ "undefined"
1770
1878
  ]
1771
1879
  }
1772
1880
  },
@@ -1775,7 +1883,9 @@
1775
1883
  "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1776
1884
  "value": {
1777
1885
  "type": [
1778
- "number"
1886
+ "number",
1887
+ "null",
1888
+ "undefined"
1779
1889
  ]
1780
1890
  }
1781
1891
  },
@@ -1798,7 +1908,9 @@
1798
1908
  "description": "Sublevel toggle state.",
1799
1909
  "value": {
1800
1910
  "type": [
1801
- "boolean"
1911
+ "boolean",
1912
+ "null",
1913
+ "undefined"
1802
1914
  ]
1803
1915
  }
1804
1916
  },
@@ -1807,7 +1919,9 @@
1807
1919
  "description": "Hides the toggle icon and disables toggling a tree sublevel.",
1808
1920
  "value": {
1809
1921
  "type": [
1810
- "boolean"
1922
+ "boolean",
1923
+ "null",
1924
+ "undefined"
1811
1925
  ]
1812
1926
  }
1813
1927
  },
@@ -1816,7 +1930,9 @@
1816
1930
  "description": "Current level of the tree represented with a horizontal offset\nof the toggle button.",
1817
1931
  "value": {
1818
1932
  "type": [
1819
- "number"
1933
+ "number",
1934
+ "null",
1935
+ "undefined"
1820
1936
  ]
1821
1937
  }
1822
1938
  }
@@ -1838,7 +1954,9 @@
1838
1954
  "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.",
1839
1955
  "value": {
1840
1956
  "type": [
1841
- "boolean"
1957
+ "boolean",
1958
+ "null",
1959
+ "undefined"
1842
1960
  ]
1843
1961
  }
1844
1962
  },
@@ -1847,7 +1965,9 @@
1847
1965
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1848
1966
  "value": {
1849
1967
  "type": [
1850
- "number"
1968
+ "number",
1969
+ "null",
1970
+ "undefined"
1851
1971
  ]
1852
1972
  }
1853
1973
  },
@@ -1867,7 +1987,9 @@
1867
1987
  "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.",
1868
1988
  "value": {
1869
1989
  "type": [
1870
- "boolean"
1990
+ "boolean",
1991
+ "null",
1992
+ "undefined"
1871
1993
  ]
1872
1994
  }
1873
1995
  },
@@ -1876,7 +1998,9 @@
1876
1998
  "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.",
1877
1999
  "value": {
1878
2000
  "type": [
1879
- "boolean"
2001
+ "boolean",
2002
+ "null",
2003
+ "undefined"
1880
2004
  ]
1881
2005
  }
1882
2006
  },
@@ -1940,7 +2064,9 @@
1940
2064
  "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.",
1941
2065
  "value": {
1942
2066
  "type": [
1943
- "boolean"
2067
+ "boolean",
2068
+ "null",
2069
+ "undefined"
1944
2070
  ]
1945
2071
  }
1946
2072
  },
@@ -1949,7 +2075,7 @@
1949
2075
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
1950
2076
  "value": {
1951
2077
  "type": [
1952
- "GridColumnTextAlign",
2078
+ "string",
1953
2079
  "null",
1954
2080
  "undefined"
1955
2081
  ]
@@ -1985,7 +2111,9 @@
1985
2111
  "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.",
1986
2112
  "value": {
1987
2113
  "type": [
1988
- "boolean"
2114
+ "boolean",
2115
+ "null",
2116
+ "undefined"
1989
2117
  ]
1990
2118
  }
1991
2119
  },
@@ -1994,7 +2122,9 @@
1994
2122
  "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
1995
2123
  "value": {
1996
2124
  "type": [
1997
- "number"
2125
+ "number",
2126
+ "null",
2127
+ "undefined"
1998
2128
  ]
1999
2129
  }
2000
2130
  },
@@ -2025,7 +2155,9 @@
2025
2155
  "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.",
2026
2156
  "value": {
2027
2157
  "type": [
2028
- "boolean"
2158
+ "boolean",
2159
+ "null",
2160
+ "undefined"
2029
2161
  ]
2030
2162
  }
2031
2163
  },
@@ -2034,7 +2166,9 @@
2034
2166
  "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.",
2035
2167
  "value": {
2036
2168
  "type": [
2037
- "boolean"
2169
+ "boolean",
2170
+ "null",
2171
+ "undefined"
2038
2172
  ]
2039
2173
  }
2040
2174
  },
@@ -2120,7 +2254,9 @@
2120
2254
  "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.",
2121
2255
  "value": {
2122
2256
  "type": [
2123
- "boolean"
2257
+ "boolean",
2258
+ "null",
2259
+ "undefined"
2124
2260
  ]
2125
2261
  }
2126
2262
  },
@@ -2129,7 +2265,7 @@
2129
2265
  "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
2130
2266
  "value": {
2131
2267
  "type": [
2132
- "GridColumnTextAlign",
2268
+ "string",
2133
2269
  "null",
2134
2270
  "undefined"
2135
2271
  ]
@@ -2152,7 +2288,7 @@
2152
2288
  },
2153
2289
  {
2154
2290
  "name": "vaadin-grid",
2155
- "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.1.0-beta1/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-column) element to configure the grid columns. Set `path` and `header`\nshorthand properties for the columns to define what gets rendered in the cells of the column.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column path=\"name.first\" header=\"First name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"name.last\" header=\"Last name\"></vaadin-grid-column>\n <vaadin-grid-column path=\"email\"></vaadin-grid-column>\n</vaadin-grid>\n```\n\nFor custom content `vaadin-grid-column` element provides you with three types of `renderer` callback functions: `headerRenderer`,\n`renderer` and `footerRenderer`.\n\nEach of those renderer functions provides `root`, `column`, `model` arguments when applicable.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `column`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\nRenderers are called on initialization of new column cells and each time the\nrelated row model is updated. DOM generated during the renderer call can be reused\nin the next renderer call and will be provided with the `root` argument.\nOn first call it will be empty.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n <vaadin-grid-column></vaadin-grid-column>\n</vaadin-grid>\n```\n```js\nconst grid = document.querySelector('vaadin-grid');\ngrid.items = [{'name': 'John', 'surname': 'Lennon', 'role': 'singer'},\n {'name': 'Ringo', 'surname': 'Starr', 'role': 'drums'}];\n\nconst columns = grid.querySelectorAll('vaadin-grid-column');\n\ncolumns[0].headerRenderer = function(root) {\n root.textContent = 'Name';\n};\ncolumns[0].renderer = function(root, column, model) {\n root.textContent = model.item.name;\n};\n\ncolumns[1].headerRenderer = function(root) {\n root.textContent = 'Surname';\n};\ncolumns[1].renderer = function(root, column, model) {\n root.textContent = model.item.surname;\n};\n\ncolumns[2].headerRenderer = function(root) {\n root.textContent = 'Role';\n};\ncolumns[2].renderer = function(root, column, model) {\n root.textContent = model.item.role;\n};\n```\n\nThe following properties are available in the `model` argument:\n\nProperty name | Type | Description\n--------------|------|------------\n`index`| Number | The index of the item.\n`item` | String or Object | The item.\n`level` | Number | Number of the item's tree sublevel, starts from 0.\n`expanded` | Boolean | True if the item's tree sublevel is expanded.\n`selected` | Boolean | True if the item is selected.\n`detailsOpened` | Boolean | True if the item's row details are open.\n`hasChildren` | Boolean | True if the item has children\n\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid-tree-toggle)\n\n__Note that the helper elements must be explicitly imported.__\nIf you want to import everything at once you can use the `all-imports.js` entrypoint.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid#property-dataProvider) function property.\nThe `<vaadin-grid>` calls this function lazily, only when it needs more data\nto be displayed.\n\nSee the [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta1/#/elements/vaadin-grid#property-dataProvider) property\ndocumentation for the detailed data provider arguments description.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n // page: the requested page index\n // pageSize: number of items on one page\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then(({ employees, totalSize }) => {\n callback(employees, totalSize);\n });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n fetch(url)\n .then((res) => res.json())\n .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n---------------------------|----------------\n`row` | Row in the internal table\n`body-row` | Body row in the internal table\n`header-row` | Header row in the internal table\n`footer-row` | Footer row in the internal table\n`collapsed-row` | Collapsed row\n`expanded-row` | Expanded row\n`selected-row` | Selected row\n`nonselectable-row` | Row that the user may not select or deselect\n`details-opened-row` | Row with details open\n`odd-row` | Odd row\n`even-row` | Even row\n`first-row` | The first body row\n`first-header-row` | The first header row\n`first-footer-row` | The first footer row\n`last-row` | The last body row\n`last-header-row` | The last header row\n`last-footer-row` | The last footer row\n`dragstart-row` | Set on the row for one frame when drag is starting.\n`dragover-above-row` | Set on the row when the a row is dragged over above\n`dragover-below-row` | Set on the row when the a row is dragged over below\n`dragover-on-top-row` | Set on the row when the a row is dragged over on top\n`drag-disabled-row` | Set to a row that isn't available for dragging\n`drop-disabled-row` | Set to a row that can't be dropped on top of\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`odd-row-cell` | Cell in an odd row\n`even-row-cell` | Cell in an even row\n`first-row-cell` | Cell in the first body row\n`last-row-cell` | Cell in the last body row\n`first-header-row-cell` | Cell in the first header row\n`first-footer-row-cell` | Cell in the first footer row\n`last-header-row-cell` | Cell in the last header row\n`last-footer-row-cell` | Cell in the last footer row\n`loading-row-cell` | Cell in a row that is waiting for data from data provider\n`selected-row-cell` | Cell in a selected row\n`nonselectable-row-cell` | Cell in a row that the user may not select or deselect\n`collapsed-row-cell` | Cell in a collapsed row\n`expanded-row-cell` | Cell in an expanded row\n`details-opened-row-cell` | Cell in an row with details open\n`dragstart-row-cell` | Cell in the ghost image row, but not in a source row\n`drag-source-row-cell` | Cell in a source row, but not in the ghost image\n`dragover-above-row-cell` | Cell in a row that has another row dragged over above\n`dragover-below-row-cell` | Cell in a row that has another row dragged over below\n`dragover-on-top-row-cell` | Cell in a row that has another row dragged over on top\n`drag-disabled-row-cell` | Cell in a row that isn't available for dragging\n`drop-disabled-row-cell` | Cell in a row that can't be dropped on top of\n`frozen-cell` | Frozen cell in the internal table\n`frozen-to-end-cell` | Frozen to end cell in the internal table\n`last-frozen-cell` | Last frozen cell\n`first-frozen-to-end-cell` | First cell frozen to end\n`first-column-cell` | First visible cell on a row\n`last-column-cell` | Last visible cell on a row\n`reorder-allowed-cell` | Cell in a column where another column can be reordered\n`reorder-dragging-cell` | Cell in a column currently being reordered\n`resize-handle` | Handle for resizing the columns\n`empty-state` | The container for the content to be displayed when there are no body rows to show\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading` | Set when the grid is loading data from data provider | :host\n`interacting` | Keyboard navigation in interaction mode | :host\n`navigating` | Keyboard navigation in navigation mode | :host\n`overflow` | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering` | Set when the grid's columns are being reordered | :host\n`dragover` | Set when the grid (not a specific row) is dragged over | :host\n`dragging-rows` | Set when grid rows are dragged | :host\n`reorder-status` | Reflects the status of a cell while columns are being reordered | cell\n`frozen` | Frozen cell | cell\n`frozen-to-end` | Cell frozen to end | cell\n`last-frozen` | Last frozen cell | cell\n`first-frozen-to-end` | First cell frozen to end | cell\n`first-column` | First visible cell on a row | cell\n`last-column` | Last visible cell on a row | cell\n`selected` | Selected row | row\n`expanded` | Expanded row | row\n`details-opened` | Row with details open | row\n`loading` | Row that is waiting for data from data provider | row\n`odd` | Odd row | row\n`first` | The first body row | row\n`last` | The last body row | row\n`dragstart` | Set for one frame when starting to drag a row. The value is a number when dragging multiple rows | row\n`dragover` | Set when the row is dragged over | row\n`drag-disabled` | Set to a row that isn't available for dragging | row\n`drop-disabled` | Set to a row that can't be dropped on top of | row\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
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.1.0-beta3/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/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.1.0-beta3/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/25.1.0-beta3/#/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.1.0-beta3/#/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.1.0-beta3/#/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.",
2156
2292
  "attributes": [
2157
2293
  {
2158
2294
  "name": "accessible-name",
@@ -2170,7 +2306,9 @@
2170
2306
  "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.",
2171
2307
  "value": {
2172
2308
  "type": [
2173
- "boolean"
2309
+ "boolean",
2310
+ "null",
2311
+ "undefined"
2174
2312
  ]
2175
2313
  }
2176
2314
  },
@@ -2179,7 +2317,9 @@
2179
2317
  "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.",
2180
2318
  "value": {
2181
2319
  "type": [
2182
- "ColumnRendering"
2320
+ "string",
2321
+ "null",
2322
+ "undefined"
2183
2323
  ]
2184
2324
  }
2185
2325
  },
@@ -2188,7 +2328,9 @@
2188
2328
  "description": "Set to true to allow column reordering.",
2189
2329
  "value": {
2190
2330
  "type": [
2191
- "boolean"
2331
+ "boolean",
2332
+ "null",
2333
+ "undefined"
2192
2334
  ]
2193
2335
  }
2194
2336
  },
@@ -2197,7 +2339,7 @@
2197
2339
  "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.",
2198
2340
  "value": {
2199
2341
  "type": [
2200
- "GridDropMode",
2342
+ "string",
2201
2343
  "null",
2202
2344
  "undefined"
2203
2345
  ]
@@ -2230,7 +2372,9 @@
2230
2372
  "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
2231
2373
  "value": {
2232
2374
  "type": [
2233
- "boolean"
2375
+ "boolean",
2376
+ "null",
2377
+ "undefined"
2234
2378
  ]
2235
2379
  }
2236
2380
  },
@@ -2239,7 +2383,9 @@
2239
2383
  "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.",
2240
2384
  "value": {
2241
2385
  "type": [
2242
- "boolean"
2386
+ "boolean",
2387
+ "null",
2388
+ "undefined"
2243
2389
  ]
2244
2390
  }
2245
2391
  },
@@ -2259,7 +2405,9 @@
2259
2405
  "description": "Number of items fetched at a time from the dataprovider.",
2260
2406
  "value": {
2261
2407
  "type": [
2262
- "number"
2408
+ "number",
2409
+ "null",
2410
+ "undefined"
2263
2411
  ]
2264
2412
  }
2265
2413
  },
@@ -2279,7 +2427,9 @@
2279
2427
  "description": "The number of root-level items in the grid.",
2280
2428
  "value": {
2281
2429
  "type": [
2282
- "number"
2430
+ "number",
2431
+ "null",
2432
+ "undefined"
2283
2433
  ]
2284
2434
  }
2285
2435
  },
@@ -2322,7 +2472,9 @@
2322
2472
  "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.",
2323
2473
  "value": {
2324
2474
  "type": [
2325
- "boolean"
2475
+ "boolean",
2476
+ "null",
2477
+ "undefined"
2326
2478
  ]
2327
2479
  }
2328
2480
  },
@@ -2342,7 +2494,9 @@
2342
2494
  "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.",
2343
2495
  "value": {
2344
2496
  "type": [
2345
- "ColumnRendering"
2497
+ "string",
2498
+ "null",
2499
+ "undefined"
2346
2500
  ]
2347
2501
  }
2348
2502
  },
@@ -2351,7 +2505,9 @@
2351
2505
  "description": "Set to true to allow column reordering.",
2352
2506
  "value": {
2353
2507
  "type": [
2354
- "boolean"
2508
+ "boolean",
2509
+ "null",
2510
+ "undefined"
2355
2511
  ]
2356
2512
  }
2357
2513
  },
@@ -2402,7 +2558,7 @@
2402
2558
  "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.",
2403
2559
  "value": {
2404
2560
  "type": [
2405
- "GridDropMode",
2561
+ "string",
2406
2562
  "null",
2407
2563
  "undefined"
2408
2564
  ]
@@ -2465,7 +2621,9 @@
2465
2621
  "description": "When `true`, all `<vaadin-grid-sorter>` are applied for sorting.",
2466
2622
  "value": {
2467
2623
  "type": [
2468
- "boolean"
2624
+ "boolean",
2625
+ "null",
2626
+ "undefined"
2469
2627
  ]
2470
2628
  }
2471
2629
  },
@@ -2474,7 +2632,9 @@
2474
2632
  "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.",
2475
2633
  "value": {
2476
2634
  "type": [
2477
- "boolean"
2635
+ "boolean",
2636
+ "null",
2637
+ "undefined"
2478
2638
  ]
2479
2639
  }
2480
2640
  },
@@ -2494,7 +2654,9 @@
2494
2654
  "description": "Number of items fetched at a time from the dataprovider.",
2495
2655
  "value": {
2496
2656
  "type": [
2497
- "number"
2657
+ "number",
2658
+ "null",
2659
+ "undefined"
2498
2660
  ]
2499
2661
  }
2500
2662
  },
@@ -2534,7 +2696,9 @@
2534
2696
  "description": "The number of root-level items in the grid.",
2535
2697
  "value": {
2536
2698
  "type": [
2537
- "number"
2699
+ "number",
2700
+ "null",
2701
+ "undefined"
2538
2702
  ]
2539
2703
  }
2540
2704
  }