@vaadin/grid 24.2.0-alpha1 → 24.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 (20) hide show
  1. package/package.json +11 -11
  2. package/src/lit/column-renderer-directives.d.ts +4 -5
  3. package/src/lit/renderer-directives.d.ts +6 -2
  4. package/src/vaadin-grid-column.d.ts +11 -0
  5. package/src/vaadin-grid-column.js +29 -1
  6. package/src/vaadin-grid-data-provider-mixin.js +4 -3
  7. package/src/vaadin-grid-helpers.js +8 -11
  8. package/src/vaadin-grid-keyboard-navigation-mixin.js +2 -1
  9. package/src/vaadin-grid-scroll-mixin.js +22 -0
  10. package/src/vaadin-grid-selection-column-base-mixin.d.ts +63 -0
  11. package/src/vaadin-grid-selection-column-base-mixin.js +342 -0
  12. package/src/vaadin-grid-selection-column.d.ts +3 -12
  13. package/src/vaadin-grid-selection-column.js +39 -122
  14. package/src/vaadin-grid-styles.js +2 -8
  15. package/src/vaadin-grid-tree-column.js +2 -1
  16. package/src/vaadin-grid.js +34 -0
  17. package/theme/lumo/vaadin-grid-styles.js +3 -12
  18. package/theme/material/vaadin-grid-styles.js +4 -16
  19. package/web-types.json +106 -195
  20. package/web-types.lit.json +41 -76
package/src/vaadin-grid.js CHANGED
@@ -12,6 +12,7 @@ import { animationFrame, microTask } from '@vaadin/component-base/src/async.js';
12
12
  import { isAndroid, isChrome, isFirefox, isIOS, isSafari, isTouch } from '@vaadin/component-base/src/browser-utils.js';
13
13
  import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
14
14
  import { Debouncer } from '@vaadin/component-base/src/debounce.js';
15
+ import { getClosestElement } from '@vaadin/component-base/src/dom-utils.js';
15
16
  import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
16
17
  import { processTemplates } from '@vaadin/component-base/src/templates.js';
17
18
  import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
@@ -497,6 +498,23 @@ class Grid extends ElementMixin(
497
498
  .sort((a, b) => a.index - b.index);
498
499
  }
499
500
 
501
+ /** @protected */
502
+ _getRowContainingNode(node) {
503
+ const content = getClosestElement('vaadin-grid-cell-content', node);
504
+ if (!content) {
505
+ return;
506
+ }
507
+
508
+ const cell = content.assignedSlot.parentElement;
509
+ return cell.parentElement;
510
+ }
511
+
512
+ /** @protected */
513
+ _isItemAssignedToRow(item, row) {
514
+ const model = this.__getRowModel(row);
515
+ return this.getItemId(item) === this.getItemId(model.item);
516
+ }
517
+
500
518
  /** @protected */
501
519
  ready() {
502
520
  super.ready();
@@ -543,6 +561,13 @@ class Grid extends ElementMixin(
543
561
  }
544
562
  }
545
563
 
564
+ /** @protected */
565
+ _focusFirstVisibleRow() {
566
+ const row = this.__getFirstVisibleItem();
567
+ this.__rowFocusMode = true;
568
+ row.focus();
569
+ }
570
+
546
571
  /** @private */
547
572
  _effectiveSizeChanged(effectiveSize, virtualizer, hasData, columnTree) {
548
573
  if (virtualizer && hasData && columnTree) {
@@ -872,6 +897,11 @@ class Grid extends ElementMixin(
872
897
  cell._vacant = true;
873
898
  });
874
899
  row.innerHTML = '';
900
+ if (section === 'body') {
901
+ // Clear the cached cell references
902
+ row.__cells = [];
903
+ row.__detailsCell = null;
904
+ }
875
905
 
876
906
  columns
877
907
  .filter((column) => !column.hidden)
@@ -890,6 +920,8 @@ class Grid extends ElementMixin(
890
920
  }
891
921
  cell.setAttribute('part', 'cell body-cell');
892
922
  cell.__parentRow = row;
923
+ // Cache the cell reference
924
+ row.__cells.push(cell);
893
925
  if (!column._bodyContentHidden) {
894
926
  row.appendChild(cell);
895
927
  }
@@ -912,6 +944,8 @@ class Grid extends ElementMixin(
912
944
  }
913
945
  this._configureDetailsCell(detailsCell);
914
946
  row.appendChild(detailsCell);
947
+ // Cache the details cell reference
948
+ row.__detailsCell = detailsCell;
915
949
  this._a11ySetRowDetailsCell(row, detailsCell);
916
950
  detailsCell._vacant = false;
917
951
  }
package/theme/lumo/vaadin-grid-styles.js CHANGED
@@ -77,10 +77,7 @@ registerStyles(
77
77
  :host([navigating]) [part~='focused-cell']:focus::before {
78
78
  content: '';
79
79
  position: absolute;
80
- top: 0;
81
- right: 0;
82
- bottom: 0;
83
- left: 0;
80
+ inset: 0;
84
81
  pointer-events: none;
85
82
  box-shadow: inset 0 0 0 2px var(--lumo-primary-color-50pct);
86
83
  }
@@ -95,10 +92,7 @@ registerStyles(
95
92
  content: '';
96
93
  position: absolute;
97
94
  z-index: 100;
98
- top: 0;
99
- right: 0;
100
- bottom: 0;
101
- left: 0;
95
+ inset: 0;
102
96
  pointer-events: none;
103
97
  box-shadow: inset 0 0 0 2px var(--lumo-primary-color-50pct);
104
98
  }
@@ -114,10 +108,7 @@ registerStyles(
114
108
  [part~='row'][dragover] [part~='cell']::after {
115
109
  content: '';
116
110
  position: absolute;
117
- top: 0;
118
- right: 0;
119
- bottom: 0;
120
- left: 0;
111
+ inset: 0;
121
112
  height: calc(var(--_lumo-grid-border-width) + 2px);
122
113
  pointer-events: none;
123
114
  background: var(--lumo-primary-color-50pct);
package/theme/material/vaadin-grid-styles.js CHANGED
@@ -76,10 +76,7 @@ registerStyles(
76
76
  content: '';
77
77
  pointer-events: none;
78
78
  position: absolute;
79
- top: 0;
80
- right: 0;
81
- bottom: 0;
82
- left: 0;
79
+ inset: 0;
83
80
  background-color: var(--material-primary-color);
84
81
  opacity: 0;
85
82
  transition: opacity 0.1s cubic-bezier(0.4, 0, 0.2, 0.1);
@@ -143,10 +140,7 @@ registerStyles(
143
140
  :host([navigating]) [part~='row']:focus::before {
144
141
  content: '';
145
142
  position: absolute;
146
- top: 0;
147
- right: 0;
148
- bottom: 0;
149
- left: 0;
143
+ inset: 0;
150
144
  pointer-events: none;
151
145
  transform: translateX(calc(-1 * var(--_grid-horizontal-scroll-position)));
152
146
  z-index: 3;
@@ -157,10 +151,7 @@ registerStyles(
157
151
  content: '';
158
152
  position: absolute;
159
153
  z-index: 100;
160
- top: 0;
161
- right: 0;
162
- bottom: 0;
163
- left: 0;
154
+ inset: 0;
164
155
  pointer-events: none;
165
156
  box-shadow: inset 0 0 0 2px var(--material-primary-color);
166
157
  }
@@ -176,10 +167,7 @@ registerStyles(
176
167
  [part~='row'][dragover] [part~='cell']::after {
177
168
  content: '';
178
169
  position: absolute;
179
- top: 0;
180
- right: 0;
181
- bottom: 0;
182
- left: 0;
170
+ inset: 0;
183
171
  height: 3px;
184
172
  pointer-events: none;
185
173
  background: var(--material-primary-color);
package/web-types.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/web-types",
3
3
  "name": "@vaadin/grid",
4
- "version": "24.2.0-alpha1",
4
+ "version": "24.2.0-alpha10",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
8
8
  "elements": [
9
9
  {
10
10
  "name": "vaadin-grid-column",
11
- "description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha1/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
11
+ "description": "A `<vaadin-grid-column>` is used to configure how a column in `<vaadin-grid>`\nshould look like.\n\nSee [`<vaadin-grid>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha10/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
12
12
  "attributes": [
13
13
  {
14
14
  "name": "resizable",
@@ -39,6 +39,15 @@
39
39
  ]
40
40
  }
41
41
  },
42
+ {
43
+ "name": "row-header",
44
+ "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.",
45
+ "value": {
46
+ "type": [
47
+ "boolean"
48
+ ]
49
+ }
50
+ },
42
51
  {
43
52
  "name": "hidden",
44
53
  "description": "When set to true, the cells for this column are hidden.",
@@ -155,6 +164,15 @@
155
164
  ]
156
165
  }
157
166
  },
167
+ {
168
+ "name": "rowHeader",
169
+ "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.",
170
+ "value": {
171
+ "type": [
172
+ "boolean"
173
+ ]
174
+ }
175
+ },
158
176
  {
159
177
  "name": "hidden",
160
178
  "description": "When set to true, the cells for this column are hidden.",
@@ -298,6 +316,15 @@
298
316
  ]
299
317
  }
300
318
  },
319
+ {
320
+ "name": "row-header",
321
+ "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.",
322
+ "value": {
323
+ "type": [
324
+ "boolean"
325
+ ]
326
+ }
327
+ },
301
328
  {
302
329
  "name": "hidden",
303
330
  "description": "When set to true, the cells for this column are hidden.",
@@ -374,6 +401,15 @@
374
401
  ]
375
402
  }
376
403
  },
404
+ {
405
+ "name": "rowHeader",
406
+ "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.",
407
+ "value": {
408
+ "type": [
409
+ "boolean"
410
+ ]
411
+ }
412
+ },
377
413
  {
378
414
  "name": "hidden",
379
415
  "description": "When set to true, the cells for this column are hidden.",
@@ -537,6 +573,15 @@
537
573
  ]
538
574
  }
539
575
  },
576
+ {
577
+ "name": "row-header",
578
+ "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.",
579
+ "value": {
580
+ "type": [
581
+ "boolean"
582
+ ]
583
+ }
584
+ },
540
585
  {
541
586
  "name": "hidden",
542
587
  "description": "When set to true, the cells for this column are hidden.",
@@ -653,6 +698,15 @@
653
698
  ]
654
699
  }
655
700
  },
701
+ {
702
+ "name": "rowHeader",
703
+ "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.",
704
+ "value": {
705
+ "type": [
706
+ "boolean"
707
+ ]
708
+ }
709
+ },
656
710
  {
657
711
  "name": "hidden",
658
712
  "description": "When set to true, the cells for this column are hidden.",
@@ -765,70 +819,8 @@
765
819
  },
766
820
  {
767
821
  "name": "vaadin-grid-selection-column",
768
- "description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.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__",
822
+ "description": "`<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`\nthat provides default renderers and functionality for item selection.\n\n#### Example:\n```html\n<vaadin-grid items=\"[[items]]\">\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/24.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__",
769
823
  "attributes": [
770
- {
771
- "name": "resizable",
772
- "description": "When set to true, the column is user-resizable.",
773
- "value": {
774
- "type": [
775
- "boolean",
776
- "null",
777
- "undefined"
778
- ]
779
- }
780
- },
781
- {
782
- "name": "frozen",
783
- "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.",
784
- "value": {
785
- "type": [
786
- "boolean"
787
- ]
788
- }
789
- },
790
- {
791
- "name": "frozen-to-end",
792
- "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.",
793
- "value": {
794
- "type": [
795
- "boolean"
796
- ]
797
- }
798
- },
799
- {
800
- "name": "hidden",
801
- "description": "When set to true, the cells for this column are hidden.",
802
- "value": {
803
- "type": [
804
- "boolean",
805
- "null",
806
- "undefined"
807
- ]
808
- }
809
- },
810
- {
811
- "name": "header",
812
- "description": "Text content to display in the header cell of the column.",
813
- "value": {
814
- "type": [
815
- "string",
816
- "null",
817
- "undefined"
818
- ]
819
- }
820
- },
821
- {
822
- "name": "text-align",
823
- "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
824
- "value": {
825
- "type": [
826
- "GridColumnTextAlign",
827
- "null",
828
- "undefined"
829
- ]
830
- }
831
- },
832
824
  {
833
825
  "name": "width",
834
826
  "description": "Width of the cells for this column.",
@@ -850,19 +842,8 @@
850
842
  }
851
843
  },
852
844
  {
853
- "name": "path",
854
- "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.",
855
- "value": {
856
- "type": [
857
- "string",
858
- "null",
859
- "undefined"
860
- ]
861
- }
862
- },
863
- {
864
- "name": "auto-width",
865
- "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.",
845
+ "name": "select-all",
846
+ "description": "When true, all the items are selected.",
866
847
  "value": {
867
848
  "type": [
868
849
  "boolean"
@@ -870,8 +851,8 @@
870
851
  }
871
852
  },
872
853
  {
873
- "name": "select-all",
874
- "description": "When true, all the items are selected.",
854
+ "name": "auto-select",
855
+ "description": "When true, the active gets automatically selected.",
875
856
  "value": {
876
857
  "type": [
877
858
  "boolean"
@@ -879,8 +860,8 @@
879
860
  }
880
861
  },
881
862
  {
882
- "name": "auto-select",
883
- "description": "When true, the active gets automatically selected.",
863
+ "name": "drag-select",
864
+ "description": "When true, rows can be selected by dragging over the selection column.",
884
865
  "value": {
885
866
  "type": [
886
867
  "boolean"
@@ -901,90 +882,6 @@
901
882
  ],
902
883
  "js": {
903
884
  "properties": [
904
- {
905
- "name": "resizable",
906
- "description": "When set to true, the column is user-resizable.",
907
- "value": {
908
- "type": [
909
- "boolean",
910
- "null",
911
- "undefined"
912
- ]
913
- }
914
- },
915
- {
916
- "name": "frozen",
917
- "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.",
918
- "value": {
919
- "type": [
920
- "boolean"
921
- ]
922
- }
923
- },
924
- {
925
- "name": "frozenToEnd",
926
- "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.",
927
- "value": {
928
- "type": [
929
- "boolean"
930
- ]
931
- }
932
- },
933
- {
934
- "name": "hidden",
935
- "description": "When set to true, the cells for this column are hidden.",
936
- "value": {
937
- "type": [
938
- "boolean",
939
- "null",
940
- "undefined"
941
- ]
942
- }
943
- },
944
- {
945
- "name": "header",
946
- "description": "Text content to display in the header cell of the column.",
947
- "value": {
948
- "type": [
949
- "string",
950
- "null",
951
- "undefined"
952
- ]
953
- }
954
- },
955
- {
956
- "name": "textAlign",
957
- "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
958
- "value": {
959
- "type": [
960
- "GridColumnTextAlign",
961
- "null",
962
- "undefined"
963
- ]
964
- }
965
- },
966
- {
967
- "name": "headerRenderer",
968
- "description": "Custom function for rendering the header content.\nReceives two arguments:\n\n- `root` The header cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
969
- "value": {
970
- "type": [
971
- "GridHeaderFooterRenderer",
972
- "null",
973
- "undefined"
974
- ]
975
- }
976
- },
977
- {
978
- "name": "footerRenderer",
979
- "description": "Custom function for rendering the footer content.\nReceives two arguments:\n\n- `root` The footer cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.",
980
- "value": {
981
- "type": [
982
- "GridHeaderFooterRenderer",
983
- "null",
984
- "undefined"
985
- ]
986
- }
987
- },
988
885
  {
989
886
  "name": "width",
990
887
  "description": "Width of the cells for this column.",
@@ -1006,30 +903,8 @@
1006
903
  }
1007
904
  },
1008
905
  {
1009
- "name": "renderer",
1010
- "description": "Custom function for rendering the cell content.\nReceives three arguments:\n\n- `root` The cell content DOM element. Append your content to it.\n- `column` The `<vaadin-grid-column>` element.\n- `model` The object with the properties related with\n the rendered item, contains:\n - `model.index` The index of the item.\n - `model.item` The item.\n - `model.expanded` Sublevel toggle state.\n - `model.level` Level of the tree represented with a horizontal offset of the toggle button.\n - `model.selected` Selected state.\n - `model.detailsOpened` Details opened state.",
1011
- "value": {
1012
- "type": [
1013
- "GridBodyRenderer",
1014
- "null",
1015
- "undefined"
1016
- ]
1017
- }
1018
- },
1019
- {
1020
- "name": "path",
1021
- "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.",
1022
- "value": {
1023
- "type": [
1024
- "string",
1025
- "null",
1026
- "undefined"
1027
- ]
1028
- }
1029
- },
1030
- {
1031
- "name": "autoWidth",
1032
- "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.",
906
+ "name": "selectAll",
907
+ "description": "When true, all the items are selected.",
1033
908
  "value": {
1034
909
  "type": [
1035
910
  "boolean"
@@ -1037,8 +912,8 @@
1037
912
  }
1038
913
  },
1039
914
  {
1040
- "name": "selectAll",
1041
- "description": "When true, all the items are selected.",
915
+ "name": "autoSelect",
916
+ "description": "When true, the active gets automatically selected.",
1042
917
  "value": {
1043
918
  "type": [
1044
919
  "boolean"
@@ -1046,8 +921,8 @@
1046
921
  }
1047
922
  },
1048
923
  {
1049
- "name": "autoSelect",
1050
- "description": "When true, the active gets automatically selected.",
924
+ "name": "dragSelect",
925
+ "description": "When true, rows can be selected by dragging over the selection column.",
1051
926
  "value": {
1052
927
  "type": [
1053
928
  "boolean"
@@ -1165,6 +1040,15 @@
1165
1040
  ]
1166
1041
  }
1167
1042
  },
1043
+ {
1044
+ "name": "row-header",
1045
+ "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.",
1046
+ "value": {
1047
+ "type": [
1048
+ "boolean"
1049
+ ]
1050
+ }
1051
+ },
1168
1052
  {
1169
1053
  "name": "hidden",
1170
1054
  "description": "When set to true, the cells for this column are hidden.",
@@ -1291,6 +1175,15 @@
1291
1175
  ]
1292
1176
  }
1293
1177
  },
1178
+ {
1179
+ "name": "rowHeader",
1180
+ "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.",
1181
+ "value": {
1182
+ "type": [
1183
+ "boolean"
1184
+ ]
1185
+ }
1186
+ },
1294
1187
  {
1295
1188
  "name": "hidden",
1296
1189
  "description": "When set to true, the cells for this column are hidden.",
@@ -1530,6 +1423,15 @@
1530
1423
  ]
1531
1424
  }
1532
1425
  },
1426
+ {
1427
+ "name": "row-header",
1428
+ "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.",
1429
+ "value": {
1430
+ "type": [
1431
+ "boolean"
1432
+ ]
1433
+ }
1434
+ },
1533
1435
  {
1534
1436
  "name": "hidden",
1535
1437
  "description": "When set to true, the cells for this column are hidden.",
@@ -1646,6 +1548,15 @@
1646
1548
  ]
1647
1549
  }
1648
1550
  },
1551
+ {
1552
+ "name": "rowHeader",
1553
+ "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.",
1554
+ "value": {
1555
+ "type": [
1556
+ "boolean"
1557
+ ]
1558
+ }
1559
+ },
1649
1560
  {
1650
1561
  "name": "hidden",
1651
1562
  "description": "When set to true, the cells for this column are hidden.",
@@ -1758,7 +1669,7 @@
1758
1669
  },
1759
1670
  {
1760
1671
  "name": "vaadin-grid",
1761
- "description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.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/24.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\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha1/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha1/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha1/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha1/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.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.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.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/24.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`expanded-row` | Expanded row\n`selected-row` | Selected row\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`last-row` | The last body 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`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 a row that user started to drag (set for one frame)\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`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.",
1672
+ "description": "`<vaadin-grid>` is a free, high quality data grid / data table Web Component. The content of the\nthe grid can be populated by using renderer callback function.\n\n### Quick Start\n\nStart with an assigning an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/24.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/24.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\nThe following helper elements can be used for further customization:\n- [`<vaadin-grid-column-group>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha10/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha10/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha10/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-alpha10/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.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.html` bundle.\n\n### Lazy Loading with Function Data Provider\n\nIn addition to assigning an array to the items property, you can alternatively\nprovide the `<vaadin-grid>` data through the\n[`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/24.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/24.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`expanded-row` | Expanded row\n`selected-row` | Selected row\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`last-row` | The last body 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`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 a row that user started to drag (set for one frame)\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`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.",
1762
1673
  "attributes": [
1763
1674
  {
1764
1675
  "name": "size",