@scoped-vaadin/grid
Version:
A free, flexible and high-quality Web Component for showing large amounts of tabular data
47 lines (43 loc) • 1.64 kB
JavaScript
/**
* @license
* Copyright (c) 2016 - 2025 Vaadin Ltd.
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
*/
import '@scoped-vaadin/checkbox/src/vaadin-checkbox.js';
import { defineCustomElement } from '@scoped-vaadin/component-base/src/define.js';
import { GridColumn } from './vaadin-grid-column.js';
import { GridSelectionColumnMixin } from './vaadin-grid-selection-column-mixin.js';
/**
* `<vaadin24-grid-selection-column>` is a helper element for the `<vaadin24-grid>`
* that provides default renderers and functionality for item selection.
*
* #### Example:
* ```html
* <vaadin24-grid>
* <vaadin24-grid-selection-column frozen auto-select></vaadin24-grid-selection-column>
*
* <vaadin24-grid-column>
* ...
* ```
*
* By default the selection column displays `<vaadin24-checkbox>` elements in the
* column cells. The checkboxes in the body rows toggle selection of the corresponding row items.
*
* When the grid data is provided as an array of [`items`](#/elements/vaadin-grid#property-items),
* the column header gets an additional checkbox that can be used for toggling
* selection for all the items at once.
*
* __The default content can also be overridden__
*
* @customElement
* @fires {CustomEvent} select-all-changed - Fired when the `selectAll` property changes.
* @extends GridColumn
* @mixes GridSelectionColumnMixin
*/
class GridSelectionColumn extends GridSelectionColumnMixin(GridColumn) {
static get is() {
return 'vaadin24-grid-selection-column';
}
}
defineCustomElement(GridSelectionColumn);
export { GridSelectionColumn };