Row Expansion

The row expansion feature provides methods and state for expanding and collapsing rows to show nested or additional content. These properties are available on the table instance when using the row expansion feature. See the row expansion guide for usage examples and configuration details.

Prop	Type
getCanSomeRowsExpand Returns whether there are any rows that can be expanded.	() => boolean
getExpandedDepth Returns the maximum depth of the expanded rows.	() => number
getExpandedRowModel Returns the row model after expansion has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getIsAllRowsExpanded Returns whether all rows are currently expanded.	() => boolean
getIsSomeRowsExpanded Returns whether there are any rows that are currently expanded.	() => boolean
getPreExpandedRowModel Returns the row model before expansion has been applied.	() => { flatRows: Row[] rows: Row[] rowsById: Record }
getToggleAllRowsExpandedHandler Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an `input[type=checkbox]` element.	() => ( event: unknown, ) => void
resetExpanded Resets the expanded state of the table to the initial state.	( defaultState?: boolean, ) => void
setExpanded Updates the expanded state of the table via an update function or value.	( updater: \| T \| ((old: T) => T), ) => void
toggleAllRowsExpanded Toggles the expanded state for all rows.	( expanded?: boolean, ) => void

getCanSomeRowsExpand

Type

() => boolean

Description

Returns whether there are any rows that can be expanded.

getExpandedDepth

Type

() => number

Description

Returns the maximum depth of the expanded rows.

getExpandedRowModel

Type

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

Description

Returns the row model after expansion has been applied.

getIsAllRowsExpanded

Type

() => boolean

Description

Returns whether all rows are currently expanded.

getIsSomeRowsExpanded

Type

() => boolean

Description

Returns whether there are any rows that are currently expanded.

getPreExpandedRowModel

Type

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

Description

Returns the row model before expansion has been applied.

getToggleAllRowsExpandedHandler

Type

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

Description

Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an input[type=checkbox] element.

resetExpanded

Type

(
  defaultState?: boolean,
) => void

Description

Resets the expanded state of the table to the initial state.

setExpanded

Type

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

Description

Updates the expanded state of the table via an update function or value.

toggleAllRowsExpanded

Type

(
  expanded?: boolean,
) => void

Description

Toggles the expanded state for all rows.

Pagination

Row Pinning