@vaadin/grid

{ "$schema": "https://json.schemastore.org/web-types", "name": "@vaadin/grid", "version": "25.2.4", "description-markup": "markdown", "contributions": { "html": { "elements": [ { "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": "footer-part-name", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "header-part-name", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "name": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "row-header", "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.", "value": { "type": [ "boolean" ] } }, { "name": "text-align", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } } ], "js": { "properties": [ { "name": "footerPartName", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "headerPartName", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "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": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "rowHeader", "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.", "value": { "type": [ "boolean" ] } }, { "name": "textAlign", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } } ], "events": [] } }, { "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/25.2.4/#/elements/vaadin-grid) documentation for instructions on how\nto configure the `<vaadin-grid-column>`.", "attributes": [ { "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": "flex-grow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footer-part-name", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "header-part-name", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "name": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "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" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "row-header", "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.", "value": { "type": [ "boolean" ] } }, { "name": "text-align", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "width", "description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.", "value": { "type": [ "string" ] } } ], "js": { "properties": [ { "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" ] } }, { "name": "flexGrow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footerPartName", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "headerPartName", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "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": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "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" ] } }, { "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.\n - `model.hasChildren` Whether the item has children.", "value": { "type": [ "GridBodyRenderer", "null", "undefined" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "rowHeader", "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.", "value": { "type": [ "boolean" ] } }, { "name": "textAlign", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "width", "description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.", "value": { "type": [ "string" ] } } ], "events": [] } }, { "name": "vaadin-grid-filter-column", "description": "`<vaadin-grid-filter-column>` is a helper element for the `<vaadin-grid>`\nthat provides default header renderer and functionality for filtering.\n\n#### Example:\n```html\n<vaadin-grid>\n <vaadin-grid-filter-column path=\"name.first\"></vaadin-grid-filter-column>\n\n <vaadin-grid-column>\n ...\n```", "attributes": [ { "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": "flex-grow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footer-part-name", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "header", "description": "Text to display as the label of the column filter text-field.", "value": { "type": [ "string" ] } }, { "name": "header-part-name", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "name": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "path", "description": "JS Path of the property in the item used for filtering the data.", "value": { "type": [ "string" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "row-header", "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.", "value": { "type": [ "boolean" ] } }, { "name": "text-align", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "width", "description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.", "value": { "type": [ "string" ] } } ], "js": { "properties": [ { "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" ] } }, { "name": "flexGrow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footerPartName", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "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": "header", "description": "Text to display as the label of the column filter text-field.", "value": { "type": [ "string" ] } }, { "name": "headerPartName", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "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": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "name": "path", "description": "JS Path of the property in the item used for filtering the data.", "value": { "type": [ "string" ] } }, { "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.\n - `model.hasChildren` Whether the item has children.", "value": { "type": [ "GridBodyRenderer", "null", "undefined" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "rowHeader", "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.", "value": { "type": [ "boolean" ] } }, { "name": "textAlign", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "width", "description": "Width of the cells for this column.\n\nPlease note that using the `em` length unit is discouraged as\nit might lead to misalignment issues if the header, body, and footer\ncells have different font sizes. Instead, use `rem` if you need\na length unit relative to the font size.", "value": { "type": [ "string" ] } } ], "events": [] } }, { "name": "vaadin-grid-filter", "description": "`<vaadin-grid-filter>` is a helper element for the `<vaadin-grid>` that provides out-of-the-box UI controls,\nand handlers for filtering the grid data.\n\n#### Example:\n```html\n<vaadin-grid-column id=\"column\"></vaadin-grid-column>\n```\n```js\nconst column = document.querySelector('#column');\ncolumn.headerRenderer = (root, column) => {\n let filter = root.firstElementChild;\n if (!filter) {\n filter = document.createElement('vaadin-grid-filter');\n root.appendChild(filter);\n }\n filter.path = 'name.first';\n};\ncolumn.renderer = (root, column, model) => {\n root.textContent = model.item.name.first;\n};\n```", "attributes": [ { "name": "path", "description": "JS Path of the property in the item used for filtering the data.", "value": { "type": [ "string" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "value", "description": "Current filter value.", "value": { "type": [ "string" ] } } ], "js": { "properties": [ { "name": "path", "description": "JS Path of the property in the item used for filtering the data.", "value": { "type": [ "string" ] } }, { "name": "value", "description": "Current filter value.", "value": { "type": [ "string" ] } } ], "events": [ { "name": "value-changed", "description": "Fired when the `value` property changes." } ] } }, { "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>\n <vaadin-grid-selection-column frozen auto-select></vaadin-grid-selection-column>\n\n <vaadin-grid-column>\n ...\n```\n\nBy default the selection column displays `<vaadin-checkbox>` elements in the\ncolumn cells. The checkboxes in the body rows toggle selection of the corresponding row items.\n\nWhen the grid data is provided as an array of [`items`](https://cdn.vaadin.com/vaadin-web-components/25.2.4/#/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": "auto-select", "description": "When true, the active item gets automatically selected.", "value": { "type": [ "boolean" ] } }, { "name": "auto-width", "description": "Override `autoWidth` to enable auto-width", "value": { "type": [ "boolean" ] } }, { "name": "drag-select", "description": "When true, rows can be selected by dragging over the selection column.", "value": { "type": [ "boolean" ] } }, { "name": "flex-grow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footer-part-name", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "header-part-name", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "name": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "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" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "row-header", "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.", "value": { "type": [ "boolean" ] } }, { "name": "select-all", "description": "When true, all the items are selected.", "value": { "type": [ "boolean" ] } }, { "name": "text-align", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "type": [ "string" ] } }, { "name": "theme", "description": "The theme variants to apply to the component.", "value": { "type": [ "string", "null", "undefined" ] } }, { "name": "width", "description": "Width of the cells for this column.", "value": { "type": [ "string" ] } } ], "js": { "properties": [ { "name": "autoSelect", "description": "When true, the active item gets automatically selected.", "value": { "type": [ "boolean" ] } }, { "name": "autoWidth", "description": "Override `autoWidth` to enable auto-width", "value": { "type": [ "boolean" ] } }, { "name": "dragSelect", "description": "When true, rows can be selected by dragging over the selection column.", "value": { "type": [ "boolean" ] } }, { "name": "flexGrow", "description": "Flex grow ratio for the cell widths. When set to 0, cell width is fixed.", "value": { "type": [ "number" ] } }, { "name": "footerPartName", "description": "Custom part name for the footer cell.", "value": { "type": [ "string" ] } }, { "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": "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": "header", "description": "Text content to display in the header cell of the column.", "value": { "type": [ "string" ] } }, { "name": "headerPartName", "description": "Custom part name for the header cell.", "value": { "type": [ "string" ] } }, { "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": "hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "type": [ "boolean" ] } }, { "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" ] } }, { "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.\n - `model.hasChildren` Whether the item has children.", "value": { "type": [ "GridBodyRenderer", "null", "undefined" ] } }, { "name": "resizable", "description": "When set to true, the column is user-resizable.", "value": { "type": [ "boolean" ] } }, { "name": "rowHeader", "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.", "value": { "type": [ "boolean" ] } }, { "name": "selectAll", "description": "When true, all the items are selected.", "value": { "type": [ "boolean" ] }