Skip to main content

Function: createGridColumnHelper()

createGridColumnHelper<TProps>(dataset): GridColumnHelper<TProps>

Defined in: api/grid-column-helper.ts:51

Call: const columnHelper = createGridColumnHelper(dataset).

Optional. A plain column object is a complete Grid column, and its renderer reads fieldValue as unknown. The helper reads TProps from the Dataset, so columnHelper.column(key, …) types that renderer from the key — an inline renderer included, with no annotation. The Dataset is not read at runtime.

const columnHelper = createGridColumnHelper(dataset);
const gridColumns = [
  'name',
  columnHelper.column('start', { columnRenderer: ({ fieldValue }) => … }), // Instant | undefined
  { field: 'scheduling:progress', columnRenderer: meter() },                // a plugin key: plain object
];

Type Parameters​

TProps​

TProps

Parameters​

dataset​

Dataset<TProps>

Returns​

GridColumnHelper<TProps>