Skip to main content

Column reordering

Prop enableColumnOrdering — engine behaviour, default false.

Guide

When to use it

Let users arrange columns to taste — drag a header, or use the move controls in the columns menu.

How it works

Enables drag-to-reorder on headers plus "move left / right" in the columns menu (showColumnsMenu), driving the engine's column order.

Gotchas

  • Pinned columns stay within their pinned zone; reordering happens inside each zone.
  • Persist the arrangement with gridState={{ key }} if it should survive a reload.

Live example

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}
enableColumnPinning enableColumnOrdering showColumnsMenu />
)
}
Loading live example…

Overview

Layerenable* (engine, resolved in useBstTable)
Typeboolean
Defaultfalse
Maps tov9 setColumnOrder (adapter menu + header drag-drop)
Status✅ done (Phase 3)
Sincev0.7.0
Settings sheetColumns

Column reordering — the adapter column menu (move left/right) and drag-to-reorder on the header (→ v9 setColumnOrder). Default: false.

Enable it

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

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