Interface: Table_RowSelection<TFeatures, TData>#

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

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

getFilteredSelectedRowModel()#

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

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

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

Builds a selected-row model from rows after filtering.

Returns#

RowModel<TFeatures, TData>

getGroupedSelectedRowModel()#

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

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

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

Builds a selected-row model from rows after grouping.

Returns#

RowModel<TFeatures, TData>

getIsAllPageRowsSelected()#

getIsAllPageRowsSelected: () => boolean;

getIsAllPageRowsSelected: () => boolean;

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

Checks whether every selectable row on the current page is selected.

Returns#

boolean

getIsAllRowsSelected()#

getIsAllRowsSelected: () => boolean;

getIsAllRowsSelected: () => boolean;

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

Checks whether every selectable filtered row is selected.

Returns#

boolean

getIsSomePageRowsSelected()#

getIsSomePageRowsSelected: () => boolean;

getIsSomePageRowsSelected: () => boolean;

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

Checks whether the current page has a partial row selection.

Returns#

boolean

getIsSomeRowsSelected()#

getIsSomeRowsSelected: () => boolean;

getIsSomeRowsSelected: () => boolean;

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

Checks whether filtered rows have a partial row selection.

Returns#

boolean

getPreSelectedRowModel()#

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

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

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

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

Returns#

RowModel<TFeatures, TData>

getSelectedRowModel()#

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

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

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

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

Returns#

RowModel<TFeatures, TData>

getToggleAllPageRowsSelectedHandler()#

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

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

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

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

Returns#

(event): void;

(event): void;

Parameters#

event#

unknown

Returns#

void

getToggleAllRowsSelectedHandler()#

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

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

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

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

Returns#

(event): void;

(event): void;

Parameters#

event#

unknown

Returns#

void

resetRowSelection()#

resetRowSelection: (defaultState?) => void;

resetRowSelection: (defaultState?) => void;

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

Resets rowSelection to initialState.rowSelection.

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

Parameters#

defaultState?#

boolean

Returns#

void

setRowSelection()#

setRowSelection: (updater) => void;

setRowSelection: (updater) => void;

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

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

Parameters#

updater#

Updater<RowSelectionState>

Returns#

void

toggleAllPageRowsSelected()#

toggleAllPageRowsSelected: (value?) => void;

toggleAllPageRowsSelected: (value?) => void;

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

Selects/deselects all rows on the current page.

Parameters#

value?#

boolean

Returns#

void

toggleAllRowsSelected()#

toggleAllRowsSelected: (value?) => void;

toggleAllRowsSelected: (value?) => void;

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

Selects/deselects all rows in the table.

Parameters#

value?#

boolean

Returns#

void