RowGroupRenderConfig

Group row rendering customization options. Controls how group header rows are displayed in the GroupingRowsPlugin.

Example

import { GroupingRowsPlugin } from '@toolbox-web/grid/all';

new GroupingRowsPlugin({
  groupOn: (row) => [row.department, row.team],
  render: {
    // Group row spans all columns
    fullWidth: true,

    // Custom label format
    formatLabel: (value, depth, key) => {
      if (depth === 0) return `Department: ${value}`;
      return `Team: ${value}`;
    },

    // Show aggregates in group rows (when not fullWidth)
    aggregators: {
      salary: 'sum',
      age: 'avg',
    },

    // Custom CSS class
    class: 'my-group-row',
  },
});

Properties

Property	Type	Description
fullWidth?	boolean	If true, group rows span all columns (single full-width cell). Default false.
formatLabel?	(value: unknown, depth: number, key: string) => string	Optional label formatter override. Receives raw group value + depth.
aggregators?	Record<string, AggregatorRef>	Optional aggregate overrides per field for group summary cells (only when not fullWidth).
class?	string	Additional CSS class applied to each group row root element.

See Also

• AggregatorRef for aggregation options