@vaadin/grid 23.3.25 → 23.4.0-alpha1

package/src/vaadin-grid-selection-column.js

@@ -5,6 +5,7 @@
  */
 import '@vaadin/checkbox/src/vaadin-checkbox.js';
 import { GridColumn } from './vaadin-grid-column.js';
+import { GridSelectionColumnBaseMixin } from './vaadin-grid-selection-column-base-mixin.js';
 
 /**
  * `<vaadin-grid-selection-column>` is a helper element for the `<vaadin-grid>`
@@ -28,74 +29,27 @@ import { GridColumn } from './vaadin-grid-column.js';
  *
  * __The default content can also be overridden__
  *
+ * @mixes GridSelectionColumnBaseMixin
  * @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
  */
-class GridSelectionColumn extends GridColumn {
+class GridSelectionColumn extends GridSelectionColumnBaseMixin(GridColumn) {
   static get is() {
     return 'vaadin-grid-selection-column';
   }
 
   static get properties() {
     return {
-      /**
-       * Width of the cells for this column.
-       */
-      width: {
-        type: String,
-        value: '58px',
-      },
-
-      /**
-       * Flex grow ratio for the cell widths. When set to 0, cell width is fixed.
-       * @attr {number} flex-grow
-       * @type {number}
-       */
-      flexGrow: {
-        type: Number,
-        value: 0,
-      },
-
-      /**
-       * When true, all the items are selected.
-       * @attr {boolean} select-all
-       * @type {boolean}
-       */
-      selectAll: {
-        type: Boolean,
-        value: false,
-        notify: true,
-      },
-
-      /**
-       * When true, the active gets automatically selected.
-       * @attr {boolean} auto-select
-       * @type {boolean}
-       */
-      autoSelect: {
-        type: Boolean,
-        value: false,
-      },
-
-      /** @private */
-      __indeterminate: Boolean,
-
       /**
        * The previous state of activeItem. When activeItem turns to `null`,
        * previousActiveItem will have an Object with just unselected activeItem
        * @private
        */
       __previousActiveItem: Object,
-
-      /** @private */
-      __selectAllHidden: Boolean,
     };
   }
 
   static get observers() {
-    return [
-      '__onSelectAllChanged(selectAll)',
-      '_onHeaderRendererOrBindingChanged(_headerRenderer, _headerCell, path, header, selectAll, __indeterminate, __selectAllHidden)',
-    ];
+    return ['__onSelectAllChanged(selectAll)'];
   }
 
   constructor() {
@@ -127,47 +81,6 @@ class GridSelectionColumn extends GridColumn {
     }
   }
 
-  /**
-   * Renders the Select All checkbox to the header cell.
-   *
-   * @override
-   */
-  _defaultHeaderRenderer(root, _column) {
-    let checkbox = root.firstElementChild;
-    if (!checkbox) {
-      checkbox = document.createElement('vaadin-checkbox');
-      checkbox.setAttribute('aria-label', 'Select All');
-      checkbox.classList.add('vaadin-grid-select-all-checkbox');
-      checkbox.addEventListener('checked-changed', this.__onSelectAllCheckedChanged.bind(this));
-      root.appendChild(checkbox);
-    }
-
-    const checked = this.__isChecked(this.selectAll, this.__indeterminate);
-    checkbox.__rendererChecked = checked;
-    checkbox.checked = checked;
-    checkbox.hidden = this.__selectAllHidden;
-    checkbox.indeterminate = this.__indeterminate;
-  }
-
-  /**
-   * Renders the Select Row checkbox to the body cell.
-   *
-   * @override
-   */
-  _defaultRenderer(root, _column, { item, selected }) {
-    let checkbox = root.firstElementChild;
-    if (!checkbox) {
-      checkbox = document.createElement('vaadin-checkbox');
-      checkbox.setAttribute('aria-label', 'Select Row');
-      checkbox.addEventListener('checked-changed', this.__onSelectRowCheckedChanged.bind(this));
-      root.appendChild(checkbox);
-    }
-
-    checkbox.__item = item;
-    checkbox.__rendererChecked = selected;
-    checkbox.checked = selected;
-  }
-
   /** @private */
   __onSelectAllChanged(selectAll) {
     if (selectAll === undefined || !this._grid) {
@@ -203,45 +116,49 @@ class GridSelectionColumn extends GridColumn {
   }
 
   /**
-   * Enables or disables the Select All mode once the Select All checkbox is switched.
-   * The listener handles only user-fired events.
+   * Override a method from `GridSelectionColumnBaseMixin` to handle the user
+   * selecting all items.
    *
-   * @private
+   * @protected
+   * @override
    */
-  __onSelectAllCheckedChanged(e) {
-    // Skip if the state is changed by the renderer.
-    if (e.target.checked === e.target.__rendererChecked) {
-      return;
-    }
-
-    this.selectAll = this.__indeterminate || e.target.checked;
+  _selectAll() {
+    this.selectAll = true;
   }
 
   /**
-   * Selects or deselects the row once the Select Row checkbox is switched.
-   * The listener handles only user-fired events.
+   * Override a method from `GridSelectionColumnBaseMixin` to handle the user
+   * deselecting all items.
    *
-   * @private
+   * @protected
+   * @override
    */
-  __onSelectRowCheckedChanged(e) {
-    // Skip if the state is changed by the renderer.
-    if (e.target.checked === e.target.__rendererChecked) {
-      return;
-    }
+  _deselectAll() {
+    this.selectAll = false;
+  }
 
-    if (e.target.checked) {
-      this._grid.selectItem(e.target.__item);
-    } else {
-      this._grid.deselectItem(e.target.__item);
-    }
+  /**
+   * Override a method from `GridSelectionColumnBaseMixin` to handle the user
+   * selecting an item.
+   *
+   * @param {Object} item the item to select
+   * @protected
+   * @override
+   */
+  _selectItem(item) {
+    this._grid.selectItem(item);
   }
 
   /**
-   * IOS needs indeterminate + checked at the same time
-   * @private
+   * Override a method from `GridSelectionColumnBaseMixin` to handle the user
+   * deselecting an item.
+   *
+   * @param {Object} item the item to deselect
+   * @protected
+   * @override
    */
-  __isChecked(selectAll, indeterminate) {
-    return indeterminate || selectAll;
+  _deselectItem(item) {
+    this._grid.deselectItem(item);
   }
 
   /** @private */
@@ -268,13 +185,13 @@ class GridSelectionColumn extends GridColumn {
       this.__withFilteredItemsArray((items) => {
         if (!this._grid.selectedItems.length) {
           this.selectAll = false;
-          this.__indeterminate = false;
+          this._indeterminate = false;
         } else if (this.__arrayContains(this._grid.selectedItems, items)) {
           this.selectAll = true;
-          this.__indeterminate = false;
+          this._indeterminate = false;
         } else {
           this.selectAll = false;
-          this.__indeterminate = true;
+          this._indeterminate = true;
         }
       });
     }
@@ -283,7 +200,7 @@ class GridSelectionColumn extends GridColumn {
 
   /** @private */
   __onDataProviderChanged() {
-    this.__selectAllHidden = !Array.isArray(this._grid.items);
+    this._selectAllHidden = !Array.isArray(this._grid.items);
   }
 
   /**

package/src/vaadin-grid.js

@@ -595,7 +595,10 @@ class Grid extends ElementMixin(
       return 0;
     }
 
-    const columnWidth = Math.max(this.__getIntrinsicWidth(col), this.__getDistributedWidth(col.parentElement, col));
+    const columnWidth = Math.max(
+      this.__getIntrinsicWidth(col),
+      this.__getDistributedWidth((col.assignedSlot || col).parentElement, col),
+    );
 
     // We're processing a regular grid-column and not a grid-column-group
     if (!innerColumn) {
@@ -1002,6 +1005,7 @@ class Grid extends ElementMixin(
     this._a11yUpdateFooterRows();
     this.__updateFooterPositioning();
     this.generateCellClassNames();
+    this.__updateHeaderAndFooter();
   }
 
   /** @private */
@@ -1125,19 +1129,22 @@ class Grid extends ElementMixin(
    * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
    */
   requestContentUpdate() {
-    if (this._columnTree) {
-      // Header and footer renderers
-      this._columnTree.forEach((level) => {
-        level.forEach((column) => {
-          if (column._renderHeaderAndFooter) {
-            column._renderHeaderAndFooter();
-          }
-        });
-      });
+    // Header and footer renderers
+    this.__updateHeaderAndFooter();
 
-      // Body and row details renderers
-      this.__updateVisibleRows();
-    }
+    // Body and row details renderers
+    this.__updateVisibleRows();
+  }
+
+  /** @private */
+  __updateHeaderAndFooter() {
+    (this._columnTree || []).forEach((level) => {
+      level.forEach((column) => {
+        if (column._renderHeaderAndFooter) {
+          column._renderHeaderAndFooter();
+        }
+      });
+    });
   }
 
   /** @protected */

package/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/grid",
-  "version": "23.3.25",
+  "version": "23.4.0-alpha1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
       "elements": [
         {
           "name": "vaadin-grid-column",
-          "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/23.3.25/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
+          "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/23.4.0-alpha1/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
           "attributes": [
             {
               "name": "resizable",
@@ -765,70 +765,8 @@
         },
         {
           "name": "vaadin-grid-selection-column",
-          "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/23.3.25/#/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__",
+          "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/23.4.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__",
           "attributes": [
-            {
-              "name": "resizable",
-              "description": "When set to true, the column is user-resizable.",
-              "value": {
-                "type": [
-                  "boolean",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "frozen",
-              "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.",
-              "value": {
-                "type": [
-                  "boolean"
-                ]
-              }
-            },
-            {
-              "name": "frozen-to-end",
-              "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.",
-              "value": {
-                "type": [
-                  "boolean"
-                ]
-              }
-            },
-            {
-              "name": "hidden",
-              "description": "When set to true, the cells for this column are hidden.",
-              "value": {
-                "type": [
-                  "boolean",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "header",
-              "description": "Text content to display in the header cell of the column.",
-              "value": {
-                "type": [
-                  "string",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "text-align",
-              "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
-              "value": {
-                "type": [
-                  "GridColumnTextAlign",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
             {
               "name": "width",
               "description": "Width of the cells for this column.",
@@ -850,19 +788,8 @@
               }
             },
             {
-              "name": "path",
-              "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.",
-              "value": {
-                "type": [
-                  "string",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "auto-width",
-              "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.",
+              "name": "select-all",
+              "description": "When true, all the items are selected.",
               "value": {
                 "type": [
                   "boolean"
@@ -870,8 +797,8 @@
               }
             },
             {
-              "name": "select-all",
-              "description": "When true, all the items are selected.",
+              "name": "auto-select",
+              "description": "When true, the active gets automatically selected.",
               "value": {
                 "type": [
                   "boolean"
@@ -879,8 +806,8 @@
               }
             },
             {
-              "name": "auto-select",
-              "description": "When true, the active gets automatically selected.",
+              "name": "drag-select",
+              "description": "When true, rows can be selected by dragging over the selection column.",
               "value": {
                 "type": [
                   "boolean"
@@ -901,90 +828,6 @@
           ],
           "js": {
             "properties": [
-              {
-                "name": "resizable",
-                "description": "When set to true, the column is user-resizable.",
-                "value": {
-                  "type": [
-                    "boolean",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "frozen",
-                "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.",
-                "value": {
-                  "type": [
-                    "boolean"
-                  ]
-                }
-              },
-              {
-                "name": "frozenToEnd",
-                "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.",
-                "value": {
-                  "type": [
-                    "boolean"
-                  ]
-                }
-              },
-              {
-                "name": "hidden",
-                "description": "When set to true, the cells for this column are hidden.",
-                "value": {
-                  "type": [
-                    "boolean",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "header",
-                "description": "Text content to display in the header cell of the column.",
-                "value": {
-                  "type": [
-                    "string",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "textAlign",
-                "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".",
-                "value": {
-                  "type": [
-                    "GridColumnTextAlign",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "headerRenderer",
-                "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.",
-                "value": {
-                  "type": [
-                    "GridHeaderFooterRenderer",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "footerRenderer",
-                "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.",
-                "value": {
-                  "type": [
-                    "GridHeaderFooterRenderer",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
               {
                 "name": "width",
                 "description": "Width of the cells for this column.",
@@ -1006,30 +849,8 @@
                 }
               },
               {
-                "name": "renderer",
-                "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.",
-                "value": {
-                  "type": [
-                    "GridBodyRenderer",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "path",
-                "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.",
-                "value": {
-                  "type": [
-                    "string",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "autoWidth",
-                "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.",
+                "name": "selectAll",
+                "description": "When true, all the items are selected.",
                 "value": {
                   "type": [
                     "boolean"
@@ -1037,8 +858,8 @@
                 }
               },
               {
-                "name": "selectAll",
-                "description": "When true, all the items are selected.",
+                "name": "autoSelect",
+                "description": "When true, the active gets automatically selected.",
                 "value": {
                   "type": [
                     "boolean"
@@ -1046,8 +867,8 @@
                 }
               },
               {
-                "name": "autoSelect",
-                "description": "When true, the active gets automatically selected.",
+                "name": "dragSelect",
+                "description": "When true, rows can be selected by dragging over the selection column.",
                 "value": {
                   "type": [
                     "boolean"
@@ -1780,7 +1601,7 @@
         },
         {
           "name": "vaadin-grid",
-          "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/23.3.25/#/elements/vaadin-grid#property-items) property to visualize your data.\n\nUse the [`<vaadin-grid-column>`](https://cdn.vaadin.com/vaadin-web-components/23.3.25/#/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/23.3.25/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/23.3.25/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/23.3.25/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/23.3.25/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/23.3.25/#/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/23.3.25/#/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/23.3.25/#/elements/vaadin-grid#property-dataProvider) in\nthe API reference below for the detailed data provider arguments description,\nand the “Assigning Data” page in the demos.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n  // page: the requested page index\n  // pageSize: number of items on one page\n  const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n  fetch(url)\n    .then((res) => res.json())\n    .then(({ employees, totalSize }) => {\n      callback(employees, totalSize);\n    });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n  const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n  fetch(url)\n    .then((res) => res.json())\n    .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`row` | Row in the internal table\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute             | Description                                                                                       | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading`             | Set when the grid is loading data from data provider                                              | :host\n`interacting`         | Keyboard navigation in interaction mode                                                           | :host\n`navigating`          | Keyboard navigation in navigation mode                                                            | :host\n`overflow`            | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering`          | Set when the grid's columns are being reordered                                                   | :host\n`dragover`            | Set when the grid (not a specific row) is dragged over                                            | :host\n`dragging-rows`       | Set when grid rows are dragged                                                                    | :host\n`reorder-status`      | Reflects the status of a cell while columns are being reordered                                   | cell\n`frozen`              | Frozen cell                                                                                       | cell\n`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/custom-theme/styling-components) documentation.",
+          "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/23.4.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/23.4.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/23.4.0-alpha1/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/23.4.0-alpha1/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/23.4.0-alpha1/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/23.4.0-alpha1/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/23.4.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/23.4.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/23.4.0-alpha1/#/elements/vaadin-grid#property-dataProvider) in\nthe API reference below for the detailed data provider arguments description,\nand the “Assigning Data” page in the demos.\n\n__Note that expanding the tree grid's item will trigger a call to the `dataProvider`.__\n\n__Also, note that when using function data providers, the total number of items\nneeds to be set manually. The total number of items can be returned\nin the second argument of the data provider callback:__\n\n```javascript\ngrid.dataProvider = ({page, pageSize}, callback) => {\n  // page: the requested page index\n  // pageSize: number of items on one page\n  const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n  fetch(url)\n    .then((res) => res.json())\n    .then(({ employees, totalSize }) => {\n      callback(employees, totalSize);\n    });\n};\n```\n\n__Alternatively, you can use the `size` property to set the total number of items:__\n\n```javascript\ngrid.size = 200; // The total number of items\ngrid.dataProvider = ({page, pageSize}, callback) => {\n  const url = `https://api.example/data?page=${page}&per_page=${pageSize}`;\n\n  fetch(url)\n    .then((res) => res.json())\n    .then((resJson) => callback(resJson.employees));\n};\n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n----------------|----------------\n`row` | Row in the internal table\n`cell` | Cell in the internal table\n`header-cell` | Header cell in the internal table\n`body-cell` | Body cell in the internal table\n`footer-cell` | Footer cell in the internal table\n`details-cell` | Row details cell in the internal table\n`focused-cell` | Focused cell in the internal table\n`resize-handle` | Handle for resizing the columns\n`reorder-ghost` | Ghost element of the header cell being dragged\n\nThe following state attributes are available for styling:\n\nAttribute             | Description                                                                                       | Part name\n----------------------|---------------------------------------------------------------------------------------------------|-----------\n`loading`             | Set when the grid is loading data from data provider                                              | :host\n`interacting`         | Keyboard navigation in interaction mode                                                           | :host\n`navigating`          | Keyboard navigation in navigation mode                                                            | :host\n`overflow`            | Set when rows are overflowing the grid viewport. Possible values: `top`, `bottom`, `start`, `end` | :host\n`reordering`          | Set when the grid's columns are being reordered                                                   | :host\n`dragover`            | Set when the grid (not a specific row) is dragged over                                            | :host\n`dragging-rows`       | Set when grid rows are dragged                                                                    | :host\n`reorder-status`      | Reflects the status of a cell while columns are being reordered                                   | cell\n`frozen`              | Frozen cell                                                                                       | cell\n`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/custom-theme/styling-components) documentation.",
           "attributes": [
             {
               "name": "size",