GroupSettings

Configuration settings for row grouping feature. Enables multi-column hierarchical grouping with expand/collapse, drag-drop, and keyboard navigation.

Props

The following table outlines the props for the GroupSettings:

NameTypeDefaultDescription
columns
string[]
[ ]

Array of field names to group by, in hierarchical order. First field is top-level group, subsequent fields are nested groups.

defaultExpanded
boolean | number
false

Initial expansion state for all groups on mount.

  • true- All groups expanded initially.
  • false- All groups collapsed initially.
  • number- Expand N levels deep (e.g., 2 = two levels).
enabled
boolean
false

Enables or disables grouping capability in the grid. When false, all grouping UI and APIs are disabled.

showDropArea
boolean
false

Shows drop area UI above grid for drag-drop grouping configuration.

type
string | GroupType
-

Defines the grouping mode, affecting UI and behavior.

  • 'GroupRows'- Default mode with group caption rows and expand/collapse functionality.
  • 'SingleColumn'- Groups are displayed in a single column(either default first visible column or separate ColumnType.SingleGroup type defined column) with indentation, no separate caption rows.
  • 'MultipleColumns'- Each grouped field has its own column, showing group values inline with data.