TableBandHeader Plugin Reference

A plugin that renders the banded cells.

Import

Use the following statement to import a plugin with embedded theme components:

import { TableBandHeader } from '@devexpress/dx-react-grid-material-ui';
// import { TableBandHeader } from '@devexpress/dx-react-grid-bootstrap4';
// import { TableBandHeader } from '@devexpress/dx-react-grid-bootstrap3';

If you want to use custom components, you can import the themeless plugin:

import { TableBandHeader } from '@devexpress/dx-react-grid';

User Reference

Dependencies

Properties

Name Type Default Description
cellComponent ComponentType<TableBandHeader.CellProps>   A component that renders a band cell.
rowComponent ComponentType<Table.RowProps>   A component that renders a band cells’ row.
columnBands Array<TableBandHeader.ColumnBands>   Specifies column bands for multi-level table header.

Interfaces

TableBandHeader.CellProps

Describes properties passed to a component that renders a table band cell.

Extends Table.CellProps

Name Type Description
children? ReactNode A React node used to render band cell content.
beforeBorder? boolean Specifies whether to show the left border.

TableBandHeader.ColumnBands

Describes properties of column bands that the TableBandHeader plugin renders.

Name Type Description
columnName? string A column name that is used to identify a column in the bands tree.
title? string The band’s title. Used only for bands and ignored for columns.
children? Array<TableBandHeader.ColumnBands> Nested bands and columns.

Plugin Components

Name Properties Description
TableBandHeader.Cell ComponentType<Table.CellProps> A component that renders a band cell.
TableBandHeader.Row ComponentType<Table.RowProps> A component that renders a band cells’ row.

Additional properties are added to the component’s root element.

Static Fields

Field Type Description
ROW_TYPE symbol The band row type’s identifier.

Plugin Developer Reference

Imports

Name Plugin Type Description
tableHeaderRows Getter Array<TableRow> Header rows to be rendered.
tableColumns Getter Array<TableColumn> Table columns.
tableCell Template Table.CellProps A template that renders a table cell.
tableRow Template Table.RowProps A template that renders a table row.

Exports

Name Plugin Type Description
tableHeaderRows Getter Array<TableRow> Table header rows.