New to KendoReactLearn about KendoReact Free.

GridColumnChildrenProps

The type of elements that the children property of the Grid accepts.

NameTypeDefaultDescription

cells?

GridCellsSettings

Specifies a set of cell components that the Grid will render instead of the built-in cell.

jsx
<GridColumn cells={{ data: CustomDataCell }} />

children?

GridColumnProps[] | ReactElement<GridColumnProps>[] | GridColumnChildrenProps[]

A collection of child columns.

jsx
<GridColumn>
  <GridColumn field="child1" />
  <GridColumn field="child2" />
</GridColumn>

className?

string

Sets custom CSS classes on the column cells.

colSpan?

number | (colSpanProps: GridColSpanProps) => number

1

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
<GridColumn colSpan={2} />

columnMenu?

React.ComponentType<GridColumnMenuProps>

Specifies a React element that will be cloned and rendered inside the column menu of the Grid (see example).

jsx
<GridColumn columnMenu={CustomColumnMenu} />

columnType?

GridColumnType

"data"

Sets the type of the column and renders a dedicated column for interaction.

jsx
<GridColumn columnType="checkbox" />

contextMenu?

boolean | GridContextMenuOptions | (options: GridCellBaseOptions) => boolean | GridContextMenuOptions

Specifies the context menu settings that will be applied to the column.

jsx
<GridColumn contextMenu={{ enabled: true }} />

editable?

boolean

Defines whether the column is editable (more information and examples).

jsx
<GridColumn editable={true} />

editor?

GridDataType

'text'

Defines the editor type. Used when the column enters the edit mode (more information and examples).

jsx
<GridColumn editor="date" />

field?

string

Sets the data field that the column binds to.

filter?

GridDataType

'text'

Defines the filter type that will be rendered inside the filter row.

jsx
<GridColumn filter="numeric" />

filterable?

boolean

true

Defines if a filter UI will be rendered for this column.

jsx
<GridColumn filterable={false} />

filterTitle?

string

Defines the title which will be set to the input element in the filter cell.

jsx
<GridColumn filterTitle="Custom Filter Title" />

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

true

Determines if the column can be dragged to the group panel.

jsx
<GridColumn groupable={false} />

headerClassName?

string

Sets custom CSS classes on the header cell.

headerSelectionValue?

boolean

Indicates that the header selection checkbox is checked when true.

hidden?

boolean

false

Controls the visibility of the Grid's column.

jsx
<GridColumn hidden={true} />

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

false

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
<GridColumn locked={true} />

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.

jsx
<GridColumn media="(min-width: 600px)" />

SVGIcon

Overrides the default (three vertical dots) column menu icon or the icon set through the (columnMenuIcon) property.

jsx
<GridColumn menuIcon={CustomIcon} />

minResizableWidth?

number

10

Sets the minimum resize width (in pixels).

orderIndex?

number

0

Determines the column position. Smaller orderIndex values render first.

props

GridColumnProps

The props object containing GridColumn properties.

reorderable?

boolean

true

Enables column reordering when true.

resizable?

boolean

true

Enables column resizing when true.

rowSpannable?

boolean | GridRowSpannableSettings

Defines if the cells of the column should be spanned when their values are the same.

jsx
<GridColumn rowSpannable={true} />

sortable?

boolean | GridColumnSortSettings

true

Allows the column headers to be clicked and the sortChange event emitted. You have to handle the sortChange event yourself and sort the data.

jsx
<GridColumn sortable={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 name prop.

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).

Not finding the help you need?
Contact Support