{ "$schema": "https://json.schemastore.org/web-types", "name": "@vaadin/crud", "version": "25.1.0", "description-markup": "markdown", "framework": "lit", "framework-config": { "enable-when": { "node-packages": [ "lit" ] } }, "contributions": { "html": { "elements": [ { "name": "vaadin-crud-edit", "description": "`` is a helper element for `` that provides\nan easily themable button that fires an `edit` event with the row item as detail\nwhen clicked.\n\nTypical usage is in a `` of a custom `` inside\na `` to enable editing.", "extension": true, "attributes": [ { "name": "?disabled", "description": "When disabled, the button is rendered as \"dimmed\" and prevents all\nuser interactions (mouse and keyboard).\n\nSince disabled buttons are not focusable and cannot react to hover\nevents by default, it can cause accessibility issues by making them\nentirely invisible to assistive technologies, and prevents the use\nof Tooltips to explain why the action is not available. This can be\naddressed by enabling the feature flag `accessibleDisabledButtons`,\nwhich makes disabled buttons focusable and hoverable, while still\npreventing them from being triggered:\n\n```js\n// Set before any button is attached to the DOM.\nwindow.Vaadin.featureFlags.accessibleDisabledButtons = true\n```", "value": { "kind": "expression" } }, { "name": "@edit", "description": "Fired when user on the icon.", "value": { "kind": "expression" } } ] }, { "name": "vaadin-crud-edit-column", "description": "`` is a helper element for the ``\nthat provides a clickable and themable edit icon.\n\nTypical usage is in a custom `` inside a ``.\n\n#### Example:\n```html\n\n \n\n \n ...\n```", "extension": true, "attributes": [ { "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": { "kind": "expression" } }, { "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": { "kind": "expression" } }, { "name": "?hidden", "description": "When set to true, the cells for this column are hidden.", "value": { "kind": "expression" } }, { "name": "?resizable", "description": "When set to true, the column is user-resizable.", "value": { "kind": "expression" } }, { "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": { "kind": "expression" } }, { "name": ".ariaLabel", "description": "The arial-label for the edit button", "value": { "kind": "expression" } }, { "name": ".footerPartName", "description": "Custom part name for the footer cell.", "value": { "kind": "expression" } }, { "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 `` element.", "value": { "kind": "expression" } }, { "name": ".header", "description": "Text content to display in the header cell of the column.", "value": { "kind": "expression" } }, { "name": ".headerPartName", "description": "Custom part name for the header cell.", "value": { "kind": "expression" } }, { "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 `` element.", "value": { "kind": "expression" } }, { "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": { "kind": "expression" } }, { "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 `` 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": { "kind": "expression" } }, { "name": ".textAlign", "description": "Aligns the columns cell content horizontally.\nSupported values: \"start\", \"center\" and \"end\".", "value": { "kind": "expression" } }, { "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": { "kind": "expression" } } ] }, { "name": "vaadin-crud", "description": "`` is a Web Component for [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) operations.\n\n### Quick Start\n\nAssign an array to the [`items`](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-crud#property-items) property.\n\nA grid and an editor will be automatically generated and configured based on the data structure provided.\n\n```html\n\n```\n```js\nconst crud = document.querySelector('vaadin-crud');\n\ncrud.items = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n```\n\n### Data Provider Function\n\nOtherwise, you can provide a [`dataProvider`](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-crud#property-dataProvider) function.\n\n```js\nconst crud = document.querySelector('vaadin-crud');\n\nconst users = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n\ncrud.dataProvider = (params, callback) => {\n const chunk = users.slice(params.page * params.pageSize, params.page * params.pageSize + params.pageSize);\n callback(chunk, people.length);\n};\n```\n\nNOTE: The auto-generated editor only supports string types. If you need to handle special cases\ncustomizing the editor is discussed below.\n\n### Customization\n\nAlternatively you can fully configure the component by using `slot` names.\n\nSlot name | Description\n---------------|----------------\n`grid` | To replace the auto-generated grid with a custom one.\n`form` | To replace the auto-generated form.\n`save-button` | To replace the \"Save\" button.\n`cancel-button`| To replace the \"Cancel\" button.\n`delete-button`| To replace the \"Delete\" button.\n`toolbar` | To provide the toolbar content (by default, it's empty).\n`new-button` | To replace the \"New item\" button.\n\n#### Example:\n\n```html\n\n \n \n \n \n \n\n \n \n \n \n\n
Total singers: 2
\n \n\n \n \n \n\n```\n```js\nconst crud = document.querySelector('#crud');\n\nconst column1 = document.querySelector('#column1');\ncolumn1.headerRenderer = (root, column) => {\n root.textContent = 'Name';\n};\ncolumn1.renderer = (root, column, model) => {\n root.textContent = model.item.name;\n};\n\nconst column2 = document.querySelector('#column2');\ncolumn2.headerRenderer = (root, column) => {\n root.textContent = 'Surname';\n};\ncolumn2.renderer = (root, column, model) => {\n root.textContent = model.item.surname;\n};\n\ncrud.items = [\n { name: 'John', surname: 'Lennon', role: 'singer' },\n { name: 'Ringo', surname: 'Starr', role: 'drums' },\n // ... more items\n];\n```\n\n### Helpers\n\nThe following elements are used to auto-configure the grid and the editor\n- [``](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-crud-edit-column)\n- `` - can be replaced with custom [``](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-grid)\n- `` - can be replaced with custom [``](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-form-layout)\n\n### Styling\n\nThe following shadow DOM parts are available for styling when the editor is rendered next to, or below, the grid:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom of the grid. By default, it contains the `new` button\n`editor` | The editor container\n`scroller` | The wrapper for the header and the form\n`header` | The header of the editor\n`footer` | The footer of the editor\n\nThe following shadow DOM parts are available for styling when the editor renders as a dialog:\n\nPart name | Description\n----------------|----------------\n`toolbar` | Toolbar container at the bottom of the grid. By default, it contains the `new` button\n`overlay` | The dialog overlay\n`backdrop` | The dialog backdrop\n`header` | The header of the dialog\n`footer` | The footer of the dialog\n`content` | The wrapper for the form\n\nThe following custom CSS properties are available for styling:\n\nCustom CSS property |\n:--------------------------------------|\n| `--vaadin-crud-background` |\n| `--vaadin-crud-border-color` |\n| `--vaadin-crud-border-radius` |\n| `--vaadin-crud-border-width` |\n| `--vaadin-crud-editor-max-height` |\n| `--vaadin-crud-editor-max-width` |\n| `--vaadin-crud-footer-background` |\n| `--vaadin-crud-footer-gap` |\n| `--vaadin-crud-footer-padding` |\n| `--vaadin-crud-form-padding` |\n| `--vaadin-crud-header-color` |\n| `--vaadin-crud-header-font-size` |\n| `--vaadin-crud-header-font-weight` |\n| `--vaadin-crud-header-line-height` |\n| `--vaadin-crud-header-padding` |\n| `--vaadin-crud-toolbar-background` |\n| `--vaadin-crud-toolbar-padding` |\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.", "extension": true, "attributes": [ { "name": "?editOnClick", "description": "Enables user to click on row to edit it.\nNote: When enabled, auto-generated grid won't show the edit column.", "value": { "kind": "expression" } }, { "name": "?editorOpened", "description": "Reflects the opened status of the editor.", "value": { "kind": "expression" } }, { "name": "?noFilter", "description": "Disable filtering when grid is autoconfigured.", "value": { "kind": "expression" } }, { "name": "?noHead", "description": "Remove grid headers when it is autoconfigured.", "value": { "kind": "expression" } }, { "name": "?noSort", "description": "Disable sorting when grid is autoconfigured.", "value": { "kind": "expression" } }, { "name": "?noToolbar", "description": "Controls visibility state of toolbar.\nWhen set to false toolbar is hidden and shown when set to true.", "value": { "kind": "expression" } }, { "name": ".dataProvider", "description": "Function that provides items lazily. Receives arguments `params`, `callback`\n\n`params.page` Requested page index\n`params.pageSize` Current page size\n`params.filters` Currently applied filters\n`params.sortOrders` Currently applied sorting orders\n\n`callback(items, size)` Callback function with arguments:\n - `items` Current page of items\n - `size` Total number of items", "value": { "kind": "expression" } }, { "name": ".editedItem", "description": "The item being edited in the dialog.", "value": { "kind": "expression" } }, { "name": ".editorPosition", "description": "Sets how editor will be presented on desktop screen.\n\nAccepted values are:\n - `` (default) - form will open as overlay\n - `bottom` - form will open below the grid\n - `aside` - form will open on the grid side (_right_, if lft and _left_ if rtl)", "value": { "kind": "expression" } }, { "name": ".exclude", "description": "A comma-separated list of fields to be excluded from the generated grid and the generated editor.\n\nWhen [`include`](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-crud#property-include) is defined, this parameter is ignored.\n\nDefault is to exclude all private fields (those properties starting with underscore)", "value": { "kind": "expression" } }, { "name": ".i18n", "description": "The object used to localize this component. To change the default\nlocalization, replace this with an object that provides all properties, or\njust the individual properties you want to change.\n\nThe object has the following JSON structure and default values:\n\n```js\n{\n newItem: 'New item',\n editItem: 'Edit item',\n saveItem: 'Save',\n cancel: 'Cancel',\n deleteItem: 'Delete...',\n editLabel: 'Edit',\n confirm: {\n delete: {\n title: 'Confirm delete',\n content: 'Are you sure you want to delete the selected item? This action cannot be undone.',\n button: {\n confirm: 'Delete',\n dismiss: 'Cancel'\n }\n },\n cancel: {\n title: 'Unsaved changes',\n content: 'There are unsaved modifications to the item.',\n button: {\n confirm: 'Discard',\n dismiss: 'Continue editing'\n }\n }\n }\n}\n```", "value": { "kind": "expression" } }, { "name": ".include", "description": "A comma-separated list of fields to include in the generated grid and the generated editor.\n\nIt can be used to explicitly define the field order.\n\nWhen it is defined [`exclude`](https://cdn.vaadin.com/vaadin-web-components/25.1.0/#/elements/vaadin-crud#property-exclude) is ignored.\n\nDefault is undefined meaning that all properties in the object should be mapped to fields.", "value": { "kind": "expression" } }, { "name": ".items", "description": "An array containing the items which will be stamped to the column template instances.", "value": { "kind": "expression" } }, { "name": "@cancel", "description": "Fired when user discards edition. If the default is prevented, then\nno action is performed, user is responsible to close dialog and reset\nitem and grid.", "value": { "kind": "expression" } }, { "name": "@delete", "description": "Fired when user wants to delete item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed", "value": { "kind": "expression" } }, { "name": "@edit", "description": "Fired when user wants to edit an existing item. If the default is prevented, then\na new item is not assigned to the form, giving that responsibility to the app, though\ndialog is always opened.", "value": { "kind": "expression" } }, { "name": "@edited-item-changed", "description": "Fired when the `editedItem` property changes.", "value": { "kind": "expression" } }, { "name": "@editor-opened-changed", "description": "Fired when the `editorOpened` property changes.", "value": { "kind": "expression" } }, { "name": "@items-changed", "description": "Fired when the `items` property changes.", "value": { "kind": "expression" } }, { "name": "@new", "description": "Fired when user wants to create a new item.", "value": { "kind": "expression" } }, { "name": "@save", "description": "Fired when user wants to save a new or an existing item. If the default is prevented, then\nno action is performed, items array is not modified nor dialog closed", "value": { "kind": "expression" } }, { "name": "@size-changed", "description": "Fired when the `size` property changes.", "value": { "kind": "expression" } } ] } ] } } }