Interface GridColumnGroup

interface GridColumnGroup {
    children: GridColumnNode[];
    description?: string;
    freeReordering?: boolean;
    groupId: string;
    headerAlign?: GridAlignment;
    headerClassName?: GridColumnGroupHeaderClassNamePropType;
    headerName?: string;
    renderHeaderGroup?: ((params: GridColumnGroupHeaderParams) => ReactNode);
}

Hierarchy

  • Pick<GridColDef, "headerName" | "description" | "headerAlign">
    • GridColumnGroup

Properties

children description? freeReordering? groupId headerAlign? headerClassName? headerName? renderHeaderGroup?

Properties

children

children: GridColumnNode[]

The groups and columns included in this group.

Optionaldescription

description?: string

The tooltip text shown when the column header name is truncated.

OptionalfreeReordering

freeReordering?: boolean

If true, allows reordering columns outside of the group.

Default

false

groupId

groupId: string

A unique string identifying the group.

OptionalheaderAlign

headerAlign?: GridAlignment

Align column header content.

OptionalheaderClassName

headerClassName?: GridColumnGroupHeaderClassNamePropType

Class name that will be added in the column group header cell.

OptionalheaderName

headerName?: string

The title displayed in the column header cell.

OptionalrenderHeaderGroup

renderHeaderGroup?: ((params: GridColumnGroupHeaderParams) => ReactNode)

Allows to render a component in the column group header cell.

Type declaration

    • (params): ReactNode

    • Parameters

      Returns ReactNode

      The element to be rendered.

Settings

Member Visibility

On This Page

Properties