@vaadin/grid 24.2.0-beta2 → 24.2.0-beta3

package/src/vaadin-grid-tree-toggle.js

@@ -6,23 +6,8 @@
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { DirMixin } from '@vaadin/component-base/src/dir-mixin.js';
-import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-import { isFocusable } from './vaadin-grid-active-item-mixin.js';
-
-const template = document.createElement('template');
-
-template.innerHTML = `
-  <style>
-    @font-face {
-      font-family: "vaadin-grid-tree-icons";
-      src: url(data:application/font-woff;charset=utf-8;base64,d09GRgABAAAAAAQkAA0AAAAABrwAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABGRlRNAAAECAAAABoAAAAcgHwa6EdERUYAAAPsAAAAHAAAAB4AJwAOT1MvMgAAAZQAAAA/AAAAYA8TBIJjbWFwAAAB8AAAAFUAAAFeGJvXWmdhc3AAAAPkAAAACAAAAAgAAAAQZ2x5ZgAAAlwAAABLAAAAhIrPOhFoZWFkAAABMAAAACsAAAA2DsJI02hoZWEAAAFcAAAAHQAAACQHAgPHaG10eAAAAdQAAAAZAAAAHAxVAgBsb2NhAAACSAAAABIAAAASAIAAVG1heHAAAAF8AAAAGAAAACAACgAFbmFtZQAAAqgAAAECAAACTwflzbdwb3N0AAADrAAAADYAAABZQ7Ajh3icY2BkYGAA4twv3Vfi+W2+MnCzMIDANSOmbGSa2YEZRHEwMIEoAAoiB6sAeJxjYGRgYD7w/wADAwsDCDA7MDAyoAI2AFEEAtIAAAB4nGNgZGBg4GBgZgDRDAxMDGgAAAGbABB4nGNgZp7JOIGBlYGBaSbTGQYGhn4IzfiawZiRkwEVMAqgCTA4MDA+38d84P8BBgdmIAapQZJVYGAEAGc/C54AeJxjYYAAxlAIzQTELAwMBxgZGB0ACy0BYwAAAHicY2BgYGaAYBkGRgYQiADyGMF8FgYbIM3FwMHABISMDArP9/3/+/8/WJXC8z0Q9v8nEp5gHVwMMMAIMo+RDYiZoQJMQIKJARUA7WBhGN4AACFKDtoAAAAAAAAAAAgACAAQABgAJgA0AEIAAHichYvBEYBADAKBVHBjBT4swl9KS2k05o0XHd/yW1hAfBFwCv9sIlJu3nZaNS3PXAaXXHI8Lge7DlzF7C1RgXc7xkK6+gvcD2URmQB4nK2RQWoCMRiFX3RUqtCli65yADModOMBLLgQSqHddRFnQghIAnEUvEA3vUUP0LP0Fj1G+yb8R5iEhO9/ef/7FwFwj28o9EthiVp4hBlehcfUP4Ur8o/wBAv8CU+xVFvhOR7UB7tUdUdlVRJ6HnHWTnhM/V24In8JT5j/KzzFSi2E53hUz7jCcrcIiDDwyKSW1JEct2HdIPH1DFytbUM0PofWdNk5E5oUqb/Q6HHBiVGZpfOXkyUMEj5IyBuNmYZQjBobfsuassvnkKLe1OuBBj0VQ8cRni2xjLWsHaM0jrjx3peYA0/vrdmUYqe9iy7bzrX6eNP7Jh1SijX+AaUVbB8AAHicY2BiwA84GBgYmRiYGJkZmBlZGFkZ2djScyoLMgzZS/MyDQwMwLSruZMzlHaB0q4A76kLlwAAAAEAAf//AA94nGNgZGBg4AFiMSBmYmAEQnYgZgHzGAAD6wA2eJxjYGBgZACCKxJigiD6mhFTNowGACmcA/8AAA==) format('woff');
-      font-weight: normal;
-      font-style: normal;
-    }
-  </style>
-`;
-
-document.head.appendChild(template.content);
+import { ThemableMixin } from '@vaadin/vaadin-themable-mixin';
+import { GridTreeToggleMixin } from './vaadin-grid-tree-toggle-mixin.js';
 
 /**
  * `<vaadin-grid-tree-toggle>` is a helper element for the `<vaadin-grid>`
@@ -75,138 +60,21 @@ document.head.appendChild(template.content);
  * @customElement
  * @extends HTMLElement
  * @mixes ThemableMixin
+ * @mixes DirMixin
+ * @mixes GridTreeToggleMixin
  */
-class GridTreeToggle extends ThemableMixin(DirMixin(PolymerElement)) {
+class GridTreeToggle extends GridTreeToggleMixin(ThemableMixin(DirMixin(PolymerElement))) {
+  static get is() {
+    return 'vaadin-grid-tree-toggle';
+  }
+
   static get template() {
     return html`
-      <style>
-        :host {
-          display: inline-flex;
-          align-items: baseline;
-          max-width: 100%;
-
-          /* CSS API for :host */
-          --vaadin-grid-tree-toggle-level-offset: 1em;
-          --_collapsed-icon: '\\e7be\\00a0';
-        }
-
-        :host([dir='rtl']) {
-          --_collapsed-icon: '\\e7bd\\00a0';
-        }
-
-        :host([hidden]) {
-          display: none !important;
-        }
-
-        :host(:not([leaf])) {
-          cursor: pointer;
-        }
-
-        #level-spacer,
-        [part='toggle'] {
-          flex: none;
-        }
-
-        #level-spacer {
-          display: inline-block;
-          width: calc(var(---level, '0') * var(--vaadin-grid-tree-toggle-level-offset));
-        }
-
-        [part='toggle']::before {
-          font-family: 'vaadin-grid-tree-icons';
-          line-height: 1em; /* make icon font metrics not affect baseline */
-        }
-
-        :host(:not([expanded])) [part='toggle']::before {
-          content: var(--_collapsed-icon);
-        }
-
-        :host([expanded]) [part='toggle']::before {
-          content: '\\e7bc\\00a0'; /* icon glyph + single non-breaking space */
-        }
-
-        :host([leaf]) [part='toggle'] {
-          visibility: hidden;
-        }
-
-        slot {
-          display: block;
-          overflow: hidden;
-          text-overflow: ellipsis;
-        }
-      </style>
-
       <span id="level-spacer"></span>
       <span part="toggle"></span>
       <slot></slot>
     `;
   }
-
-  static get is() {
-    return 'vaadin-grid-tree-toggle';
-  }
-
-  static get properties() {
-    return {
-      /**
-       * Current level of the tree represented with a horizontal offset
-       * of the toggle button.
-       * @type {number}
-       */
-      level: {
-        type: Number,
-        value: 0,
-        observer: '_levelChanged',
-      },
-
-      /**
-       * Hides the toggle icon and disables toggling a tree sublevel.
-       * @type {boolean}
-       */
-      leaf: {
-        type: Boolean,
-        value: false,
-        reflectToAttribute: true,
-      },
-
-      /**
-       * Sublevel toggle state.
-       * @type {boolean}
-       */
-      expanded: {
-        type: Boolean,
-        value: false,
-        reflectToAttribute: true,
-        notify: true,
-      },
-    };
-  }
-
-  /** @protected */
-  ready() {
-    super.ready();
-
-    this.addEventListener('click', (e) => this._onClick(e));
-  }
-
-  /** @private */
-  _onClick(e) {
-    if (this.leaf) {
-      return;
-    }
-    if (isFocusable(e.target) || e.target instanceof HTMLLabelElement) {
-      return;
-    }
-
-    e.preventDefault();
-    this.expanded = !this.expanded;
-  }
-
-  /** @private */
-  _levelChanged(level) {
-    const value = Number(level).toString();
-    this.style.setProperty('---level', value);
-  }
 }
 
 defineCustomElement(GridTreeToggle);

package/web-types.json

@@ -1,14 +1,14 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/grid",
-  "version": "24.2.0-beta2",
+  "version": "24.2.0-beta3",
   "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/24.2.0-beta2/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
+          "name": "vaadin-grid-column-group",
+          "description": "A `<vaadin-grid-column-group>` is used to make groups of columns in `<vaadin-grid>` and\nto configure additional headers and footers.\n\nGroups can be nested to create complex header and footer configurations.\n\n#### Example:\n```html\n<vaadin-grid-column-group resizable id=\"columnGroup\">\n  <vaadin-grid-column id=\"column1\"></vaadin-grid-column>\n  <vaadin-grid-column id=\"column2\"></vaadin-grid-column>\n</vaadin-grid-column-group>\n```\n```js\nconst columnGroup = document.querySelector('#columnGroup');\ncolumnGroup.headerRenderer = (root, columnGroup) => {\n  root.textContent = 'header';\n}\n\nconst column1 = document.querySelector('#column1');\ncolumn1.headerRenderer = (root, column) => { ... };\ncolumn1.renderer = (root, column, model) => { ... };\n\nconst column2 = document.querySelector('#column2');\ncolumn2.headerRenderer = (root, column) => { ... };\ncolumn2.renderer = (root, column, model) => { ... };\n```",
           "attributes": [
             {
               "name": "resizable",
@@ -81,46 +81,6 @@
                 ]
               }
             },
-            {
-              "name": "width",
-              "description": "Width of the cells for this column.",
-              "value": {
-                "type": [
-                  "string",
-                  "null",
-                  "undefined"
-                ]
-              }
-            },
-            {
-              "name": "flex-grow",
-              "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
-              "value": {
-                "type": [
-                  "number"
-                ]
-              }
-            },
-            {
-              "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.",
-              "value": {
-                "type": [
-                  "boolean"
-                ]
-              }
-            },
             {
               "name": "theme",
               "description": "The theme variants to apply to the component.",
@@ -227,65 +187,14 @@
                     "undefined"
                   ]
                 }
-              },
-              {
-                "name": "width",
-                "description": "Width of the cells for this column.",
-                "value": {
-                  "type": [
-                    "string",
-                    "null",
-                    "undefined"
-                  ]
-                }
-              },
-              {
-                "name": "flexGrow",
-                "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
-                "value": {
-                  "type": [
-                    "number"
-                  ]
-                }
-              },
-              {
-                "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.",
-                "value": {
-                  "type": [
-                    "boolean"
-                  ]
-                }
               }
             ],
             "events": []
           }
         },
         {
-          "name": "vaadin-grid-column-group",
-          "description": "A `<vaadin-grid-column-group>` is used to make groups of columns in `<vaadin-grid>` and\nto configure additional headers and footers.\n\nGroups can be nested to create complex header and footer configurations.\n\n#### Example:\n```html\n<vaadin-grid-column-group resizable id=\"columnGroup\">\n  <vaadin-grid-column id=\"column1\"></vaadin-grid-column>\n  <vaadin-grid-column id=\"column2\"></vaadin-grid-column>\n</vaadin-grid-column-group>\n```\n```js\nconst columnGroup = document.querySelector('#columnGroup');\ncolumnGroup.headerRenderer = (root, columnGroup) => {\n  root.textContent = 'header';\n}\n\nconst column1 = document.querySelector('#column1');\ncolumn1.headerRenderer = (root, column) => { ... };\ncolumn1.renderer = (root, column, model) => { ... };\n\nconst column2 = document.querySelector('#column2');\ncolumn2.headerRenderer = (root, column) => { ... };\ncolumn2.renderer = (root, column, model) => { ... };\n```",
+          "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/24.2.0-beta3/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.",
           "attributes": [
             {
               "name": "resizable",
@@ -358,6 +267,46 @@
                 ]
               }
             },
+            {
+              "name": "width",
+              "description": "Width of the cells for this column.",
+              "value": {
+                "type": [
+                  "string",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "flex-grow",
+              "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
+              "value": {
+                "type": [
+                  "number"
+                ]
+              }
+            },
+            {
+              "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.",
+              "value": {
+                "type": [
+                  "boolean"
+                ]
+              }
+            },
             {
               "name": "theme",
               "description": "The theme variants to apply to the component.",
@@ -464,6 +413,57 @@
                     "undefined"
                   ]
                 }
+              },
+              {
+                "name": "width",
+                "description": "Width of the cells for this column.",
+                "value": {
+                  "type": [
+                    "string",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "flexGrow",
+                "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.",
+                "value": {
+                  "type": [
+                    "number"
+                  ]
+                }
+              },
+              {
+                "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.",
+                "value": {
+                  "type": [
+                    "boolean"
+                  ]
+                }
               }
             ],
             "events": []
@@ -819,7 +819,7 @@
         },
         {
           "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/24.2.0-beta2/#/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/24.2.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__",
           "attributes": [
             {
               "name": "resizable",
@@ -1884,7 +1884,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/24.2.0-beta2/#/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-beta2/#/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-beta2/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta2/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta2/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta2/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta2/#/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-beta2/#/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-beta2/#/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.",
+          "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-beta3/#/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-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\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-beta3/#/elements/vaadin-grid-column-group)\n- [`<vaadin-grid-filter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta3/#/elements/vaadin-grid-filter)\n- [`<vaadin-grid-sorter>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta3/#/elements/vaadin-grid-sorter)\n- [`<vaadin-grid-selection-column>`](https://cdn.vaadin.com/vaadin-web-components/24.2.0-beta3/#/elements/vaadin-grid-selection-column)\n- [`<vaadin-grid-tree-toggle>`](https://cdn.vaadin.com/vaadin-web-components/24.2.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.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-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/24.2.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`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.",
           "attributes": [
             {
               "name": "size",