TanStack

table_toggleAllRowsSelected

Function: table_toggleAllRowsSelected()

ts
function table_toggleAllRowsSelected<TFeatures, TData>(
   table,
   value?,
   opts?): void;

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

Selects or deselects every selectable row before grouping.

Omitting value toggles based on table_getIsAllRowsSelected(table). Selecting skips sub-rows whose ancestors block descent via enableSubRowSelection. Deselecting removes matching selectable ids from the existing selection map; rows that cannot be selected keep their selection unless opts.deselectAll is true.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Parameters

table

Table_Internal<TFeatures, TData>

value?

boolean

opts?

deselectAll?

boolean

Returns

void

Example

ts
table_toggleAllRowsSelected(table)