Documentation

Column Pinning

Column pinning (also known as freezing or sticking) allows you to keep important columns visible while horizontally scrolling through wide tables, making it easier to maintain context.

CodeSandbox

Basic Implementation

To pin columns, simply add the pinned property to your header objects:

Column Pinning Configuration

PropertyRequiredDescriptionExample
HeaderObject.pinned
enum
Optional
Pins the column to the left or right side of the table, keeping it visible during horizontal scrolling.
Options:
left
right

Essential columns

To lock columns so users cannot hide them or unpin them from an edge, and to keep them in a fixed leading group when reordering inside each pin section, set isEssential on the column's header object.

Saving pin layout

Use tableRef.getPinnedState() and tableRef.applyPinnedState(...) to read and restore left / main / right accessor lists (TableRefType).