Header API Reference

buildHeaderGroups

Function: buildHeaderGroups()

ts
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>[]