Package-level declarations

Types

Link copied to clipboard
external interface A11yMixin
Link copied to clipboard
external interface ActiveItemMixin
Link copied to clipboard
external interface ArrayDataProviderMixin
Link copied to clipboard
external interface BooleanOrString

Union of:

Link copied to clipboard
external interface ColumnAutoWidthMixin

A mixin providing grid column auto-width functionality.

Link copied to clipboard
external interface ColumnBaseMixin
Link copied to clipboard
abstract external class ColumnObserver

A helper for observing flattened child column list of an element.

Link copied to clipboard
Link copied to clipboard
external interface ColumnReorderingMixin
Link copied to clipboard
external interface ColumnResizingMixin
Link copied to clipboard
external interface DataProviderMixin
Link copied to clipboard
external interface DragAndDropMixin
Link copied to clipboard
external interface DynamicColumnsMixin
Link copied to clipboard
external interface EventContextMixin
Link copied to clipboard
external interface FilterMixin
Link copied to clipboard
object Grid
Link copied to clipboard

Attribute names of <vaadin-grid>, for use with setAttribute.

Link copied to clipboard
typealias GridBodyRenderer = (HTMLElement, GridColumnElement, GridItemModel) -> Unit

Renders a grid body cell.

Link copied to clipboard

Generates CSS part names for grid cells.

Link copied to clipboard

Attribute names of <vaadin-grid-column>, for use with setAttribute.

Link copied to clipboard
abstract external class GridColumnElement : HTMLElement, GridColumnMixin, PolylitMixin

A <vaadin-grid-column> is used to configure how a column in <vaadin-grid> should look like.

Link copied to clipboard
external interface GridColumnElementOrDouble

Union of:

Link copied to clipboard

Attribute names of <vaadin-grid-column-group>, for use with setAttribute.

Link copied to clipboard
abstract external class GridColumnGroupElement : HTMLElement, GridColumnGroupMixin, PolylitMixin

A <vaadin-grid-column-group> is used to make groups of columns in <vaadin-grid> and to configure additional headers and footers.

Link copied to clipboard

A mixin providing common vaadin-grid-column-group functionality.

Link copied to clipboard
Link copied to clipboard

Loads grid items lazily, page by page.

Link copied to clipboard

Receives a page of items, and optionally the total item count, from a GridDataProvider.

Link copied to clipboard
external interface GridDataProviderParams

Parameters passed to a GridDataProvider.

Link copied to clipboard

Decides whether an item can be dragged.

Link copied to clipboard

<vaadin-grid> is a free, high quality data grid / data table Web Component. The content of the the grid can be populated by using renderer callback function.

Link copied to clipboard
external interface GridEventContext

Context about the event target inside a grid.

Link copied to clipboard
object GridEvents

Typed event names of <vaadin-grid>, for use with addEventHandler.

Link copied to clipboard

Attribute names of <vaadin-grid-filter>, for use with setAttribute.

Link copied to clipboard

Attribute names of <vaadin-grid-filter-column>, for use with setAttribute.

Link copied to clipboard

<vaadin-grid-filter-column> is a helper element for the <vaadin-grid> that provides default header renderer and functionality for filtering.

Link copied to clipboard
external interface GridFilterColumnMixin
Link copied to clipboard
external interface GridFilterDefinition

A filter applied by a GridDataProvider.

Link copied to clipboard

<vaadin-grid-filter> is a helper element for the <vaadin-grid> that provides out-of-the-box UI controls, and handlers for filtering the grid data.

Link copied to clipboard
external interface GridFilterElementMixin
Link copied to clipboard

Typed event names of <vaadin-grid-filter>, for use with addEventHandler.

Link copied to clipboard
typealias GridHeaderFooterRenderer = (HTMLElement, GridColumnElement) -> Unit

Renders a grid header or footer cell.

Link copied to clipboard
external interface GridItemModel

The model passed to grid item renderers and item-based callbacks.

Link copied to clipboard
typealias GridRowDetailsRenderer = (HTMLElement, GridElement, GridItemModel) -> Unit

Renders the row details of an item.

Link copied to clipboard

Attribute names of <vaadin-grid-selection-column>, for use with setAttribute.

Link copied to clipboard
external interface GridSelectionColumnBaseMixin

A mixin that provides basic functionality for the <vaadin-grid-selection-column>. This includes properties, cell rendering, and overridable methods for handling changes to the selection state.

Link copied to clipboard

<vaadin-grid-selection-column> is a helper element for the <vaadin-grid> that provides default renderers and functionality for item selection.

Link copied to clipboard

Typed event names of <vaadin-grid-selection-column>, for use with addEventHandler.

Link copied to clipboard

Attribute names of <vaadin-grid-sort-column>, for use with setAttribute.

Link copied to clipboard

<vaadin-grid-sort-column> is a helper element for the <vaadin-grid> that provides default header renderer and functionality for sorting.

Link copied to clipboard

Typed event names of <vaadin-grid-sort-column>, for use with addEventHandler.

Link copied to clipboard
external interface GridSortColumnMixin
Link copied to clipboard

Attribute names of <vaadin-grid-sorter>, for use with setAttribute.

Link copied to clipboard
external interface GridSorterDefinition

A sort order applied by a GridDataProvider.

Link copied to clipboard

<vaadin-grid-sorter> is a helper element for the <vaadin-grid> that provides out-of-the-box UI controls, visual feedback, and handlers for sorting the grid data.

Link copied to clipboard

Typed event names of <vaadin-grid-sorter>, for use with addEventHandler.

Link copied to clipboard
external interface GridSorterMixin

A mixin providing common sorter functionality.

Link copied to clipboard

Attribute names of <vaadin-grid-tree-column>, for use with setAttribute.

Link copied to clipboard

<vaadin-grid-tree-column> is a helper element for the <vaadin-grid> that provides default renderer and functionality for toggling tree/hierarchical items.

Link copied to clipboard
external interface GridTreeColumnMixin
Link copied to clipboard

Attribute names of <vaadin-grid-tree-toggle>, for use with setAttribute.

Link copied to clipboard

<vaadin-grid-tree-toggle> is a helper element for the <vaadin-grid> that provides toggle and level display functionality for the item tree.

Link copied to clipboard

Typed event names of <vaadin-grid-tree-toggle>, for use with addEventHandler.

Link copied to clipboard
external interface GridTreeToggleMixin
Link copied to clipboard
external interface HeaderFooterRenderingMixin

A mixin providing rendering of header and footer rows based on the column tree.

Link copied to clipboard
external interface KeyboardNavigationMixin
Link copied to clipboard
external interface ResizeMixin

A mixin to observe size changes of the grid and its main parts.

Link copied to clipboard
external interface RowDetailsMixin
Link copied to clipboard
external interface ScrollMixin
Link copied to clipboard
external interface SelectionMixin
Link copied to clipboard
external interface SortMixin
Link copied to clipboard
external interface StylingMixin

Functions

Link copied to clipboard
fun createGrid(configure: GridElement.() -> Unit = {}): GridElement

Creates a <vaadin-grid> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-column> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-column-group> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-filter> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-filter-column> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-selection-column> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-sort-column> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-sorter> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-tree-column> element. The custom element is registered on first use.

Link copied to clipboard

Creates a <vaadin-grid-tree-toggle> element. The custom element is registered on first use.

Link copied to clipboard
external fun findTreeToggleCell(row: HTMLElement): HTMLElement?

Finds the cell containing the tree toggle element

Link copied to clipboard
external fun getBodyRowCells(row: HTMLTableRowElement): Array<HTMLTableCellElement>

Returns the cells of the given row, excluding the details cell.

Link copied to clipboard
external fun getClosestCell(node: Node): HTMLElement?

Returns the grid cell that contains the given node, if any.

Link copied to clipboard
external fun iterateChildren(container: HTMLElement, callback: (HTMLElement) -> Unit)
Link copied to clipboard
external fun iterateRowCells(row: HTMLTableRowElement, callback: (HTMLTableCellElement) -> Unit)

Iterates over the cells of a row. This includes the details cell if present and any other cell that may be physically detached from the row due to lazy column reordering.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid.js, registering <vaadin-grid>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-column.js, registering <vaadin-grid-column>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-column-group.js, registering <vaadin-grid-column-group>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-filter.js, registering <vaadin-grid-filter>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-filter-column.js, registering <vaadin-grid-filter-column>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-selection-column.js, registering <vaadin-grid-selection-column>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-sort-column.js, registering <vaadin-grid-sort-column>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-sorter.js, registering <vaadin-grid-sorter>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-tree-column.js, registering <vaadin-grid-tree-column>, and returns the element class.

Link copied to clipboard

Imports @vaadin/grid/src/vaadin-grid-tree-toggle.js, registering <vaadin-grid-tree-toggle>, and returns the element class.

Link copied to clipboard
external fun updateBooleanRowStates(row: HTMLElement, states: JsAny)
Link copied to clipboard
external fun updateCellsPart(cells: Array<HTMLTableCellElement>, part: String, value: BooleanOrString?)
Link copied to clipboard
external fun updateCellState(cell: HTMLElement, attribute: String, value: BooleanOrString?, part: String, oldPart: String?)
Link copied to clipboard
external fun updateColumnOrders(columns: Array<JsAny>, scope: Double, baseOrder: Double)
Link copied to clipboard
external fun updatePart(element: HTMLElement, part: String, value: BooleanOrString?)
Link copied to clipboard
external fun updateState(element: HTMLElement, attribute: String, value: BooleanOrString?)
Link copied to clipboard
external fun updateStringRowStates(row: HTMLElement, states: JsAny)