Skip to content

GridListViewColDef API

Extended documentation for the GridListViewColDef interface with detailed information on the module's properties and available APIs.

Demos

Import

import { GridListViewColDef } from '@mui/x-data-grid';
// or
import { GridListViewColDef } from '@mui/x-data-grid-pro';
// or
import { GridListViewColDef } from '@mui/x-data-grid-premium';


Column Definition interface used for the list view column.

Properties

The unique identifier of the column. Used to map with [[GridRowModel]] values.

Type:string


Optional

Align cell content.

Type:'center' | 'left' | 'right'


Optional

Class name added to cells in this column.

Type:(params: GridCellParams<R, V, V, GridTreeNode>) => string | string


Optional

Display mode for the cell: - 'text': For text-based cells (default) - 'flex': For cells with HTMLElement children

Type:'flex' | 'text'


Optional

Override the component rendered as cell for this column.

Type:(params: GridRenderCellParams<R, V, F, GridTreeNodeWithRender>) => Iterable<ReactNode> | Promise<AwaitedReactNode> | ReactElement<unknown, string | JSXElementConstructor<any>> | ReactPortal | bigint | boolean | number | string