New to KendoReactStart a free 30-day trial

The settings for grouping the data of the Grid (see example).

Definition

Package:@progress/kendo-react-grid

Properties

Sets the visualization mode for grouped data.

The available options are:

  • 'default' — Renders the legacy indent-cell grouping layout (default behavior).
  • 'compact' — Removes the empty indent cells; group headers span the full row width.
  • 'singleColumn' — Renders a single dedicated group column for all group levels.
  • 'multipleColumns' — Renders one dedicated group column per group level.
Default:

'default'

enabled?

boolean

Determines if grouping by dragging and dropping the column headers is allowed and if the group header is visible.

The group expandable settings.

"none" | "visible" | "always"

Determines if the group footer row is visible when the group is collapsed. Defaults to none.

Customizes the synthesized group column(s). Accepts either a settings object (applied uniformly to every group column) or a GridGroupColumnFn callback invoked once per synthesized column (for per-level customization) — see GridGroupColumnFn for how invocation differs between 'singleColumn' and 'multipleColumns'.

Most settings (title, width, columnMenu, etc.) only take effect for 'singleColumn' and 'multipleColumns' — the two modes that render the group column as a real, visible column. cells (custom groupHeader/groupFooter templates) is the exception and applies in every displayMode, including 'default' and 'compact' — see GridGroupColumnSettings.cells.

Hides the data column for each field the Grid is grouped by, in every displayMode. The grouped field's value is already shown in the group header row (or, in 'singleColumn'/'multipleColumns' mode, in the synthesized group column), so the original data column can be hidden to avoid duplication.

Default:

false

When enabled, the group footer row sticks to the bottom of the scrollable area so that it remains visible while scrolling through group data rows. Requires the footer property to be set to 'always' or 'visible'.

Default:

false

When enabled, the group header row sticks to the top of the scrollable area so that it remains visible while scrolling through group data rows.

Default:

false