@kanunilabs/datagrid-react / GroupingConfig
Interface: GroupingConfig
Properties
collapsedByDefault?
optionalcollapsedByDefault?:boolean
Start groups collapsed instead of expanded.
display?
optionaldisplay?:"fullWidth"|"aligned"|"column"
How a group row is drawn (rival analysis G-GRP-01).
'fullWidth'(default): one banner across the grid — caption, value, count, and the group summaries written out after them.'aligned': a row of cells like any other. The group's name, count and toggle sit in the first visible column, indented by level, and each group summary sits UNDER ITS OWN COLUMN — the subtotal layout of a spreadsheet report, readable down the column. Where a column has two summaries, the first one declared is shown.'column': as'aligned', but the name, count and toggle sit in a column of their own at the start (pinned left), with its own header, width and sort —groupColumnconfigures it. A record's cell there is empty. The column exists only while rows are grouped.
groupBy?
optionalgroupBy?:string|string[] |null
Column(s) to group by. A string (or single-element array) is single-level grouping — Community. An array of 2+ is multi-level, an Enterprise feature (approved decision #4); the engine supports both, the edition gates it.
groupColumn?
optionalgroupColumn?:object
The group column of display: 'column'. headerName defaults to the
grouped columns' names ("Region › Country"); width to 200, minWidth
to 80. The user's resize is kept in the view state like any column's.
headerName?
optionalheaderName?:string
minWidth?
optionalminWidth?:number
width?
optionalwidth?:number
groupSummaries?
optionalgroupSummaries?:boolean
Attach the summaries aggregates to every group header, not just the
footer. Enterprise (approved decision #4).
panel?
optionalpanel?:boolean
Show the group panel where columns can be dropped to group.
showGroupedColumns?
optionalshowGroupedColumns?:boolean
Keep a grouped column in the data area. Default FALSE: once a column drives the group headers, repeating its value on every child row is noise — the header already states it. Matches the common default across comparable grids.
stickyHeaders?
optionalstickyHeaders?:boolean
Keep the headers of the groups the top row belongs to pinned under the column header while their rows scroll past, outermost first; the next group's header pushes them out as it arrives (rival analysis G-GRP-01). Default false. Client data only: a remote view does not hold the rows between a header and the top edge, so it cannot tell which group that is.