Skip to main content

Row pinning

Prop enableRowPinning — engine behaviour, default false.

Guide

When to use it

Keep specific rows in view while the rest scroll — a totals row at the bottom, a highlighted record at the top.

How it works

Adds a leading pin control; pinned rows freeze to the top or bottom of the scroll area (sticky), out of the normal flow.

Gotchas

  • Row virtualization yields to row pinning (pinned rows render outside the window).
  • Pinning is view state — persist it with gridState if it should survive reloads.

Live example

Row pinning — pinned rows freeze at the top and bottom

Example source
import React from 'react'
import { BstTableMui } from '@bloomskill/table-mui'
import type { BstTableColumn } from '@bloomskill/table-engine'
import '@bloomskill/table-engine/styles.css'
type Row = { id: string; name: string; team: string; role: string; score: number }
const seed: Row[] = [
{ id: '1', name: 'Ada Lovelace', team: 'Platform', role: 'Engineer', score: 92 },
{ id: '2', name: 'Alan Turing', team: 'Research', role: 'Scientist', score: 88 },
{ id: '3', name: 'Grace Hopper', team: 'Platform', role: 'Engineer', score: 95 },
{ id: '4', name: 'Katherine J.', team: 'Research', role: 'Analyst', score: 90 },
{ id: '5', name: 'Edsger Dijkstra', team: 'Platform', role: 'Architect', score: 84 },
]
const columns: BstTableColumn<Row>[] = [
{ id: 'name', accessorKey: 'name', header: 'Name' },
{ id: 'team', accessorKey: 'team', header: 'Team' },
{ id: 'role', accessorKey: 'role', header: 'Role' },
{ id: 'score', accessorKey: 'score', header: 'Score', sortFn: 'basic' },
]
export default function App() {
return (
<BstTableMui data={seed} columns={columns} getRowId={(r) => r.id}
enableRowPinning initialState={{ rowPinning: { top: ['1'], bottom: ['5'] } }}
styles={{ root: { maxHeight: 210 } }} pagination={false} showToolbar={false} />
)
}
Loading live example…

Overview

Layerenable* (engine, resolved in useBstTable)
Typeboolean
Defaultfalse
Maps tov9 rowPinningFeature — leading pin column; frozen top/bottom rows (sticky)
Status✅ done
Sincev0.14.0
Settings sheetRows

Row pinning — freeze rows to the top/bottom of the grid via a leading pin column; pinned rows stay put across sort/filter/pagination and stick while the body scrolls. Opt-in. Default false. Maps to v9 enableRowPinning.

Enable it

<BstTableMui
data={rows}
columns={columns}
enableRowPinning
/>

Swap BstTableMui for BstTableShadcn (and the CSS import) for the shadcn skin — same props.

Spec coverage

Spec codes (A1, C2, X8, …) are Bst-Table's internal requirement IDs from the capability matrix; P0P2 mark the delivery phase. They are traceability tags, not part of the public API.

  • G1 · Freeze / pin rows & columns — ✅ built. column pin P3 + row pin v0.14.0 (enableRowPinning)