GridColumnProps
The props of the GridColumn component.
Name | Type | Default | Description |
---|---|---|---|
cell? |
|
Defines the component that will be rendered as a cell. If not set, a | |
cells? |
|
Sets a set of cells components that the Grid will render instead of the built-in cell. | |
children? |
|
A collection of child columns. | |
className? |
|
Sets the custom CSS classes to the column cells. | |
columnMenu? |
|
Specifies a React element that will be cloned and rendered inside the column menu of the Grid (see example). | |
editable? |
|
Defines whether the column is editable (more information and examples). | |
editor? |
|
Defines the editor type. Used when the column enters the edit mode (more information and examples). Defaults to | |
field? |
|
The field to which the column is bound. | |
filter? |
|
Defines the filter type that will be rendered inside the filter row. Defaults to | |
filterable? |
|
Defines if a filter UI will be rendered for this column. Defaults to | |
filterCell? |
|
Defines the component that will be rendered as a filter cell. If not set, a | |
filterTitle? |
|
Defines the title which will be set to the input element in the filter cell. | |
footerCell? |
|
Defines the component that will be rendered as a footer cell.
The footer has to render an HTML jsx
| |
format? |
|
The format that is applied to the value before it is displayed.
Takes the | |
groupable? |
|
Determines if the column can be dragged to the group panel. Defaults to | |
headerCell? |
|
Defines the component that will be rendered as a header cell. If not set, a | |
headerClassName? |
|
Sets the custom CSS classes to the column header cell. | |
headerSelectionValue? |
|
Defines if the header selection checkbox is checked. | |
hidden? |
|
Controls the visibility of Grid's column. Defaults to | |
id? |
|
The column identifier used to distinguish columns for example in multi column header scenarios with resize and keyboard navigation.
Also used for unique key for rendering the component cells.
If not set, the component will generate unique | |
locked? |
|
Defines if the column is locked (frozen or sticky).
Locked columns are the columns that are visible at all times while the user scrolls the component horizontally.
Defaults to | |
media? |
|
Sets the screen size condition that needs to be satisfied for a column to remain visible. If you set the hidden property, the behavior of media is overridden. | |
menuIcon? |
|
Overrides the default(three vertical dots) column menu icon or the icon set through the ( | |
minResizableWidth? |
|
The width of the column (in pixels) below which the user is not able to resize the column through the UI. Defaults to | |
orderIndex? |
|
Determinates the position of the column.
Columns with smaller | |
reorderable? |
|
Indicates whether the column is reorderable. | |
resizable? |
|
Indicates whether the column is resizable. | |
sortable? |
|
Allows the column headers to be clicked and the | |
title? |
|
The title of the column. | |
width? |
|
The width of the column (in pixels). |