Docs
CodeRabbit
Cloudflare
Railway
Netlify
WorkOS
AG Grid
OpenRouter
Clerk
SerpAPI
Prisma
Electric
Sentry
Unkey
CodeRabbit
Cloudflare
Railway
Netlify
WorkOS
AG Grid
OpenRouter
Clerk
SerpAPI
Prisma
Electric
Sentry
Unkey
Table API Reference
Column API Reference
Row API Reference
Cell API Reference
Header API Reference
Features API Reference
Static Functions API Reference
Legacy API Reference
Header API Reference

buildHeaderGroups

Function: buildHeaderGroups()

ts
function buildHeaderGroups<TFeatures, TData, TValue>(
   allColumns, 
   columnsToGroup, 
   table, 
   headerFamily?): HeaderGroup<TFeatures, TData>[];
function buildHeaderGroups<TFeatures, TData, TValue>(
   allColumns, 
   columnsToGroup, 
   table, 
   headerFamily?): HeaderGroup<TFeatures, TData>[];

Defined in: core/headers/buildHeaderGroups.ts:16

Builds the nested header group structure for a table.

The result accounts for visible leaf columns, pinned column groups, and placeholder headers needed to render multi-level headers.

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

TValue

TValue extends unknown = unknown

Parameters

allColumns

Column<TFeatures, TData, TValue>[]

columnsToGroup

Column<TFeatures, TData, TValue>[]

table

Table_Internal<TFeatures, TData>

headerFamily?

"left" | "right" | "center"

Returns

HeaderGroup<TFeatures, TData>[]