package.src.vaadin-grid-selection-column-base-mixin.d.ts Maven / Gradle / Ivy
/**
* @license
* Copyright (c) 2016 - 2023 Vaadin Ltd.
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
*/
import type { Constructor } from '@open-wc/dedupe-mixin';
export declare function GridSelectionColumnBaseMixin>(
base: T,
): Constructor> & T;
/**
* A mixin that provides basic functionality for the
* ``. This includes properties, cell rendering,
* and overridable methods for handling changes to the selection state.
*
* **NOTE**: This mixin is re-used by the Flow component, and as such must not
* implement any selection state updates for the column element or the grid.
* Web component-specific selection state updates must be implemented in the
* `` itself, by overriding the protected methods
* provided by this mixin.
*/
export declare class GridSelectionColumnBaseMixinClass {
/**
* When true, all the items are selected.
* @attr {boolean} select-all
*/
selectAll: boolean;
/**
* When true, the active gets automatically selected.
* @attr {boolean} auto-select
*/
autoSelect: boolean;
/**
* When true, rows can be selected by dragging over the selection column.
* @attr {boolean} drag-select
*/
dragSelect: boolean;
/**
* Override to handle the user selecting all items.
*/
protected _selectAll(): void;
/**
* Override to handle the user deselecting all items.
*/
protected _deselectAll(): void;
/**
* Override to handle the user selecting an item.
*/
protected _selectItem(item: TItem): void;
/**
* Override to handle the user deselecting an item.
*/
protected _deselectItem(item: TItem): void;
}