GridAttributes

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

Properties

Link copied to clipboard

String used to label the grid to screen reader users.

Link copied to clipboard
const val activeItem: String

The item user has last interacted with. Turns to null after user deactivates the item by re-interacting with the currently active item.

Link copied to clipboard

If true, the grid's height is defined by its rows.

Link copied to clipboard

A function that allows generating CSS part names for grid cells in Shadow DOM based on their row and column, for styling from outside using the ::part() selector.

Link copied to clipboard

Allows you to choose between modes for rendering columns in the grid:

Link copied to clipboard

Set to true to allow column reordering.

Link copied to clipboard
const val dataProvider: String

Function that provides items lazily. Receives arguments params, callback

Link copied to clipboard
const val disabled: String

If true, the user cannot interact with this element.

Link copied to clipboard
const val dragFilter: String

A function that filters dragging of specific grid rows. The return value should be false if dragging of the row should be disabled.

Link copied to clipboard
const val dropFilter: String

A function that filters dropping on specific grid rows. The return value should be false if dropping on the row should be disabled.

Link copied to clipboard
const val dropMode: String

Defines the locations within the Grid row where an element can be dropped.

Link copied to clipboard
const val i18n: String

The object used to localize this component. To change the default localization, replace this with an object that provides all properties, or just the individual properties you want to change.

Link copied to clipboard

A function to check whether a specific item in the grid may be selected or deselected by the user. Used by the selection column to conditionally enable to disable checkboxes for individual items. This function does not prevent programmatic selection/deselection of items. Changing the function does not modify the currently selected items.

Link copied to clipboard

Path to an item sub-property that indicates whether the item has child items.

Link copied to clipboard
const val itemIdPath: String

Path to an item sub-property that identifies the item.

Link copied to clipboard
const val loading: String

true while data is being requested from the data provider.

Link copied to clipboard
const val multiSort: String

When true, all <vaadin-grid-sorter> are applied for sorting.

Link copied to clipboard

When true, Shift-clicking an unsorted column's sorter adds it to the multi-sort. Shift + Space does the same action via keyboard. This property has precedence over the multiSort property. If multiSortOnShiftClick is true, the multiSort property is effectively ignored.

Link copied to clipboard

Controls how columns are added to the sort order when using multi-sort. The sort order is visually indicated by numbers in grid sorters placed in column headers.

Link copied to clipboard
const val pageSize: String

Number of items fetched at a time from the dataprovider.

Link copied to clipboard

Custom function for rendering the content of the row details. Receives three arguments:

Link copied to clipboard

Marks the grid's rows to be available for dragging.

Link copied to clipboard
const val size: String

The number of root-level items in the grid.

Link copied to clipboard
const val theme: String

The theme variants to apply to the component.