TanStack

table_getToggleAllPageRowsSelectedHandler

ts
function table_getToggleAllPageRowsSelectedHandler<TFeatures, TData>(table): (e) => void;

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

Creates a checkbox-style handler that selects or deselects current page rows.

The handler reads event.target.checked, so it is intended for controls whose checked state means "all page rows selected".

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

table

Table_Internal<TFeatures, TData>

Returns

(e) => void

Example

ts
const onChange = table_getToggleAllPageRowsSelectedHandler(table)