New to KendoReactStart a free 30-day trial

TreeListColumnProps
Premium

The props of the columns of the TreeList component.

NameTypeDefaultDescription

cell?

React.ComponentType<TreeListCellProps>

Defines the component that will be rendered as a cell. If not set, a TreeListCell will be rendered by default.

children?

TreeListColumnProps[]

A collection of child columns.

className?

string

Sets custom CSS classes on the column cells.

columnMenu?

React.ComponentType<ColumnMenuProps>

The column menu component. Pass the ColumnMenuTextColumn, ColumnMenuNumericColumn, ColumnMenuDateColumn, ColumnMenuBooleanColumn or a custom component base on the type of the column data.

editCell?

React.ComponentType<TreeListCellProps>

Defines the component that will be rendered as an edit cell.

expandable?

boolean

If set to true, the column will render the icons that are used for expanding and collapsing child rows.

field?

string

Sets the data field that the column binds to.

filter?

React.ComponentType<TreeListFilterCellProps>

Deprecated. Use filterCell prop instead.

filterCell?

React.ComponentType<TreeListFilterCellProps>

Defines the component that will be rendered as a 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.

headerCell?

React.ComponentType<TreeListHeaderCellProps>

Defines the component that will be rendered as a header cell. If not set, a TreeListHeaderCell will be rendered by default.

headerClassName?

string

Sets custom CSS classes on the header cell.

headerSelectionValue?

boolean

Indicates that the header selection checkbox is checked when 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

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

minResizableWidth?

number

10

Sets the minimum resize width (in pixels).

orderIndex?

number

0

Determines the column position. Smaller orderIndex values render first.

reorderable?

boolean

true

Enables column reordering when true.

resizable?

boolean

true

Enables column resizing when true.

sortable?

boolean | ColumnSortSettings

true

Enables header click to emit the sortChange event. Handle sortChange to sort the data.

title?

string

Sets the column header text.

width?

string | number

Sets the width of the column (in pixels).

Not finding the help you need?
Contact Support