Row Selection

The row selection feature provides methods and state for selecting and managing selected rows in the table. These properties are available on the table instance when using the row selection feature. See the row selection guide for usage examples and configuration details.

Prop	Type
getFilteredSelectedRowModel Returns the row model of all rows that are selected after filtering has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getGroupedSelectedRowModel Returns the row model of all rows that are selected after grouping has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getIsAllPageRowsSelected Returns whether all rows on the current page are selected.	() => boolean
getIsAllRowsSelected Returns whether all rows in the table are selected.	() => boolean
getIsSomePageRowsSelected Returns whether any rows on the current page are selected.	() => boolean
getIsSomeRowsSelected Returns whether any rows in the table are selected.	() => boolean
getPreSelectedRowModel Returns the core row model of all rows before row selection has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getSelectedRowModel Returns the row model of all rows that are selected.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getToggleAllPageRowsSelectedHandler Returns a handler that can be used to toggle all rows on the current page.	() => ( event: unknown, ) => void
getToggleAllRowsSelectedHandler Returns a handler that can be used to toggle all rows in the table.	() => ( event: unknown, ) => void
resetRowSelection Resets the `rowSelection` state to the `initialState.rowSelection`, or `true` can be passed to force a default blank state reset to `{}`.	( defaultState?: boolean, ) => void
setRowSelection Sets or updates the `state.rowSelection` state.	( updater: \| T \| ((old: T) => T), ) => void
toggleAllPageRowsSelected Selects/deselects all rows on the current page.	( value?: boolean, ) => void
toggleAllRowsSelected Selects/deselects all rows in the table.	( value?: boolean, ) => void

getFilteredSelectedRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model of all rows that are selected after filtering has been applied.

getGroupedSelectedRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model of all rows that are selected after grouping has been applied.

getIsAllPageRowsSelected

Type

() => boolean

Description

Returns whether all rows on the current page are selected.

getIsAllRowsSelected

Type

() => boolean

Description

Returns whether all rows in the table are selected.

getIsSomePageRowsSelected

Type

() => boolean

Description

Returns whether any rows on the current page are selected.

getIsSomeRowsSelected

Type

() => boolean

Description

Returns whether any rows in the table are selected.

getPreSelectedRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

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

getSelectedRowModel

Type

() => {
  flatRows: Row[]
  rows: Row[]
  rowsById: Record
}

Description

Returns the row model of all rows that are selected.

getToggleAllPageRowsSelectedHandler

Type

() => (
  event: unknown,
) => void

Description

Returns a handler that can be used to toggle all rows on the current page.

getToggleAllRowsSelectedHandler

Type

() => (
  event: unknown,
) => void

Description

Returns a handler that can be used to toggle all rows in the table.

resetRowSelection

Type

(
  defaultState?: boolean,
) => void

Description

Resets the rowSelection state to the initialState.rowSelection, or true can be passed to force a default blank state reset to {}.

setRowSelection

Type

(
  updater:
    | T
    | ((old: T) => T),
) => void

Description

Sets or updates the state.rowSelection state.

toggleAllPageRowsSelected

Type

(
  value?: boolean,
) => void

Description

Selects/deselects all rows on the current page.

toggleAllRowsSelected

Type

(
  value?: boolean,
) => void

Description

Selects/deselects all rows in the table.

Row Pinning

Sorting