Function: row_getToggleSelectedHandler()#

function row_getToggleSelectedHandler<TFeatures, TData>(row, opts?): (e) => void;

Defined in: features/row-selection/rowSelectionFeature.utils.ts:694

Creates a checkbox-style handler that selects or deselects this row.

The handler is a no-op when the row cannot be selected and reads event.target.checked. Shift events select or deselect the inclusive range from the most recent selectable row handled by this table. Pass selectChildren: false to limit changes to rows explicitly present in the display-order interval, and deselectParents: true to remove ancestor row ids from the selection when rows are deselected.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

row#

Row<TFeatures, TData>

opts?#

ToggleSelectedOptions

Returns#

(e): void;

Parameters#

e#

unknown

Returns#

void

Example#

const onChange = row_getToggleSelectedHandler(row)