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 jsx
| |
cells? |
|
Specifies a set of cell components that the Grid will render instead of the built-in cell. jsx
| |
children? |
|
A collection of child columns. jsx
| |
className? |
|
Sets the custom CSS classes to the column cells. | |
colSpan? |
|
|
Sets the colSpan of the column which will make the row content span over multiple cells. As arguments, it takes either a number or a function that returns a number. jsx
|
columnMenu? |
|
Specifies a React element that will be cloned and rendered inside the column menu of the Grid (see example). jsx
| |
columnType? |
|
|
Sets the type of the column and renders a dedicated column for interaction. jsx
|
contextMenu? |
|
Specifies the context menu settings that will be applied to the column. jsx
| |
editable? |
|
Defines whether the column is editable (more information and examples). jsx
| |
editor? |
|
|
Defines the editor type. Used when the column enters the edit mode (more information and examples). jsx
|
field? |
|
The field to which the column is bound. | |
filter? |
|
|
Defines the filter type that will be rendered inside the filter row. jsx
|
filterable? |
|
|
Defines if a filter UI will be rendered for this column. jsx
|
filterCell? |
|
Defines the component that will be rendered as a filter cell. If not set, a jsx
| |
filterTitle? |
|
Defines the title which will be set to the input element in the filter cell. jsx
| |
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. jsx
|
headerCell? |
|
Defines the component that will be rendered as a header cell. If not set, a jsx
| |
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 the Grid's column. jsx
|
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. jsx
|
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. jsx
| |
menuIcon? |
|
Overrides the default (three vertical dots) column menu icon or the icon set through the ( jsx
| |
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. | |
rowSpannable? |
|
Defines if the cells of the column should be spanned when their values are the same. jsx
| |
sortable? |
|
|
Allows the column headers to be clicked and the jsx
|
title? |
|
The title of the column. | |
width? |
|
The width of the column (in pixels). |