TableOptions_RowPinning

Defined in: features/row-pinning/rowPinningFeature.types.ts:16

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Properties#

enableRowPinning?#

optional enableRowPinning?: boolean | ((row) => boolean);

Defined in: features/row-pinning/rowPinningFeature.types.ts:25

Allows rows to be pinned to top or bottom regions.

Provide a predicate to decide per row. Defaults to true.

keepPinnedRows?#

optional keepPinnedRows?: boolean;

Defined in: features/row-pinning/rowPinningFeature.types.ts:29

When false, pinned rows will not be visible if they are filtered or paginated out of the table. When true, pinned rows will always be visible regardless of filtering or pagination. Defaults to true.

onRowPinningChange?#

optional onRowPinningChange?: OnChangeFn<RowPinningState>;

Defined in: features/row-pinning/rowPinningFeature.types.ts:35

Called with an updater when row pinning state changes. Pair this with state.rowPinning when using external state; external atoms can own the slice without this callback.