Table_RowSelection

Defined in: features/row-selection/rowSelectionFeature.types.ts:129

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_lastSelectedRowId

_lastSelectedRowId: string | null;

Defined in: features/row-selection/rowSelectionFeature.types.ts:138

Internal

The most recent row interacted with through the row selection handler.

getFilteredSelectedRowModel

getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-selection/rowSelectionFeature.types.ts:142

Builds a selected-row model from rows after filtering.

Returns

RowModel<TFeatures, TData>

getGroupedSelectedRowModel

getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-selection/rowSelectionFeature.types.ts:146

Builds a selected-row model from rows after grouping.

Returns

RowModel<TFeatures, TData>

getIsAllPageRowsSelected

getIsAllPageRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:155

Checks whether every selectable row on the current page is selected. Sub-rows whose ancestors block sub-row selection are ignored.

Returns

boolean

getIsAllRowsSelected

getIsAllRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:160

Checks whether every selectable filtered row is selected. Sub-rows whose ancestors block sub-row selection are ignored.

Returns

boolean

getIsSomePageRowsSelected

getIsSomePageRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:164

Checks whether at least one selectable row on the current page is selected.

Returns

boolean

getIsSomeRowsSelected

getIsSomeRowsSelected: () => boolean;

Defined in: features/row-selection/rowSelectionFeature.types.ts:168

Checks whether at least one row id is selected.

Returns

boolean

getPreSelectedRowModel

getPreSelectedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-selection/rowSelectionFeature.types.ts:172

Returns the core row model of all rows before row selection has been applied.

Returns

RowModel<TFeatures, TData>

getSelectedRowIds

getSelectedRowIds: () => string[];

Defined in: features/row-selection/rowSelectionFeature.types.ts:150

Returns the ids of all selected rows.

Returns

string[]

getSelectedRowModel

getSelectedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-selection/rowSelectionFeature.types.ts:176

Builds a selected-row model from the core row model.

Returns

RowModel<TFeatures, TData>

getToggleAllPageRowsSelectedHandler

getToggleAllPageRowsSelectedHandler: () => (event) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:180

Creates a checkbox-style handler that toggles all current-page rows.

Returns

(event) => void

getToggleAllRowsSelectedHandler

getToggleAllRowsSelectedHandler: () => (event) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:184

Creates a checkbox-style handler that toggles all selectable rows.

Returns

(event) => void

resetRowSelection

resetRowSelection: (defaultState?) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:190

Resets rowSelection to initialState.rowSelection.

Pass true to ignore initial state and reset to {}.

Parameters

defaultState?

boolean

Returns

void

setRowSelection

setRowSelection: (updater) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:194

Updates row selection state with a next map or updater function.

Parameters

updater

Updater<RowSelectionState>

Returns

void

toggleAllPageRowsSelected

toggleAllPageRowsSelected: (value?, opts?) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:198

Selects/deselects all rows on the current page.

Parameters

value?

boolean

opts?

deselectAll?

boolean

Returns

void

toggleAllRowsSelected

toggleAllRowsSelected: (value?, opts?) => void;

Defined in: features/row-selection/rowSelectionFeature.types.ts:208

Selects/deselects all rows in the table.

Deselecting keeps rows that cannot be selected in the selection map unless opts.deselectAll is true.

Parameters

value?

boolean

opts?

deselectAll?

boolean

Returns

void