Row Pinning

The row pinning feature provides methods and state for pinning rows to the top or bottom of the table. These properties are available on the table instance when using the row pinning feature. See the row pinning guide for usage examples and configuration details.

Prop	Type
getBottomRows Returns all bottom pinned rows.	() => Row<TData>[]
getCenterRows Returns all rows that are not pinned to the top or bottom.	() => Row<TData>[]
getIsSomeRowsPinned Returns whether any rows are pinned. Optionally specify to only check for pinned rows in either the `top` or `bottom` position.	( position?: \| false \| 'top' \| 'bottom', ) => boolean
getTopRows Returns all top pinned rows.	() => Row<TData>[]
resetRowPinning Resets the `rowPinning` state to `initialState.rowPinning`, or `true` can be passed to force a default blank state reset to `{ top: [], bottom: [], }`.	( defaultState?: boolean, ) => void
setRowPinning Sets or updates the `state.rowPinning` state.	( updater: \| T \| ((old: T) => T), ) => void

getBottomRows

Type

() => Row<TData>[]

Description

Returns all bottom pinned rows.

getCenterRows

Type

() => Row<TData>[]

Description

Returns all rows that are not pinned to the top or bottom.

getIsSomeRowsPinned

Type

(
  position?:
    | false
    | 'top'
    | 'bottom',
) => boolean

Description

Returns whether any rows are pinned. Optionally specify to only check for pinned rows in either the top or bottom position.

getTopRows

Type

() => Row<TData>[]

Description

Returns all top pinned rows.

resetRowPinning

Type

(
  defaultState?: boolean,
) => void

Description

Resets the rowPinning state to initialState.rowPinning, or true can be passed to force a default blank state reset to { top: [], bottom: [], }.

setRowPinning

Type

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

Description

Sets or updates the state.rowPinning state.

Row Expansion

Row Selection