PinningModuleResult

Defines the row pinning module API. Manages pinned row state and pinning operations for the grid. Also exposes column pinning helpers used when the user pins/unpins a column via context menu (pinColumn(field, direction) and unpinColumn(field)).

Props

The following table outlines the props for the PinningModuleResult:

NameTypeDefaultDescription
pinColumn
(field: string, direction: ColumnPinDirection.Left | ColumnPinDirection.Right | string) => void
-

Pins a column by field (matching ColumnProps.field) to the given side. Updates uiColumns.current in place and bumps setColumnChooserState so prepareColumns reruns for the new pin direction. The sticky offset maps and pinned-cell CSS classes take effect on the next paint.

unpinColumn
(field: string) => void
-

Unpins a column by field, collapsing its pin direction to None. Bumps setColumnChooserState so prepareColumns reruns and the column flows back into the main virtual order with sticky CSS offsets dropped.