GridColumnProps
The props of the GridColumn component.
Definition
Package:@progress/kendo-react-grid
Properties
Specifies a set of cell components that the Grid will render instead of the built-in cell.
children?
GridColumnProps[] | ReactElement<GridColumnProps, string | JSXElementConstructor<any>>[] | GridColumnChildrenProps[]
A collection of child columns.
className?
string
Sets custom CSS classes on the column cells.
colSpan?
number | (colSpanProps: GridColSpanProps) => number
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.
1
columnMenu?
ComponentType<GridColumnMenuProps>
Specifies a React element that will be cloned and rendered inside the column menu of the Grid (see example).
Sets the type of the column and renders a dedicated column for interaction.
"data"
contextMenu?
boolean | GridContextMenuOptions | (options: GridCellBaseOptions) => boolean | GridContextMenuOptions
Specifies the context menu settings that will be applied to the column.
disableReorder?
boolean
Disables the ability to reorder when another column is dragged over it or tried to be reordered with keyboard.
false
editable?
boolean
Defines whether the column is editable (more information and examples).
Defines the editor type. Used when the column enters the edit mode (more information and examples).
'text'
field?
string
Sets the data field that the column binds to.
Defines the filter type that will be rendered inside the filter row.
'text'
filterable?
boolean
Defines if a filter UI will be rendered for this column.
true
filterTitle?
string
Defines the title which will be set to the input element in the filter cell.
format?
string
Applies a format to the value before display.
Takes the {0:format} form where format is a standard number format, a custom number format,
a standard date format, or a custom date format. For more information on supported formats see the
kendo-intl documentation.
groupable?
boolean
Determines if the column can be dragged to the group panel.
true
headerClassName?
string
Sets custom CSS classes on the header cell.
headerSelectionValue?
boolean
Indicates that the header selection checkbox is checked when true.
hidden?
boolean
Controls the visibility of the Grid's column.
false
id?
string
Sets the column id for distinguishing columns (multi header, resize, or keyboard navigation scenarios). Also used as the unique key for rendering cells. If not set, a unique id is generated.
locked?
boolean
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.
false
maxWidth?
number
Sets the maximum width of the column (in pixels).
media?
string
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?
SVGIcon
Overrides the default (three vertical dots) column menu icon or the icon set through the (columnMenuIcon) property.
minResizableWidth?
number
Deprecated: Use the minWidth property instead. The minResizableWidth property will be removed in a future version.
minWidth?
number
Sets the minimum width of the column (in pixels).
orderIndex?
number
Determines the column position. Smaller orderIndex values render first.
0
reorderable?
boolean
Enables column reordering when true.
true
resizable?
boolean
Enables column resizing when true.
true
rowSpannable?
boolean | GridRowSpannableSettings
Defines if the cells of the column should be spanned when their values are the same.
sortable?
boolean | GridColumnSortSettings
Allows the column headers to be clicked and the sortChange event emitted.
You have to handle the sortChange event yourself and sort the data.
true
title?
string
Sets the column header text.
validator?
FieldValidatorType | FieldValidatorType[]
The validation method for the edit field when editting is in mode dialog.
The method arguments are:
- value - The current value of the field.
- valueGetter - Function which can be used to get other fields value.
Usable when validator depends on more than one field. Supports field paths.
- fieldProps - Props of the Field component. Currently contains only the
nameprop.
Usable when one validator is used across multiple fields.
Returns string to signify error or undefined to signify validation success.
width?
string | number
Sets the width of the column (in pixels).