PinningModuleOptions

Defines options passed to the row pinning module factory. Provides the grid reference required for row pinning state and operations. uiColumns is forwarded so the module can mutate column pin direction and trigger a column re-preparation without coupling to the grid component directly.

Props

The following table outlines the props for the PinningModuleOptions:

NameTypeDefaultDescription
gridRef
RefObject<GridRef<T>>
-

Reference to the grid component.

setColumnChooserState
Dispatch<SetStateAction<object>>
-

Sentinel setter that triggers prepareColumns to re-run.

uiColumns
RefObject<ColumnProps<T>[]>
-

Live column reference that pinColumn / unpinColumn mutate in place.