SelectionSettings

Configures selection behavior in the Data Grid component. Defines settings for enabling selection, specifying selection mode, and controlling selection type. Manages how to interact with row selection in the grid.

Props

The following table outlines the props for the SelectionSettings:

NameTypeDefaultDescription
checkboxOnly
boolean
false

When checkboxOnly is set to true, row selection is possible only through the checkbox. Clicking other row or cell elements does not trigger selection.

enableToggle
boolean
false

Specifies whether row selection can be toggled. When set to true, clicking a selected row will deselect it, and clicking a deselected row will reselect it. When set to false, the selection state remains fixed once applied and cannot be toggled.

enabled
boolean
true

Determines whether row selection is enabled in the grid by default. When set to false, all selection functionality is disabled. This property directly affects the grid’s interactivity for row-based operations.

mode
string | SelectionMode
'Single' | SelectionMode.Single

Specifies the selection mode for the grid, controlling how many rows can be selected. Supports Single for selecting one row at a time or Multiple for selecting multiple rows using CTRL or SHIFT keys.

persistSelection
boolean
false

Specifies whether row selection is persisted across grid operations such as sorting, filtering, searching, paging, or refreshing. Selection persistence requires a primary key, so define at least one unique value column with the isPrimaryKey property in the column definition. When the checkbox selection feature is enabled, selection persistence is automatically set to true. Set enablePersistence to false to disable selection persistence.