TanStack

row_getToggleSelectedHandler

Function: row_getToggleSelectedHandler()

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

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

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.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

row

Row<TFeatures, TData>

opts?

ToggleSelectedOptions

Returns

ts
(e): void;

Parameters

e

unknown

Returns

void

Example

ts
const onChange = row_getToggleSelectedHandler(row)