New to Kendo UI for Vue? Start a free 30-day trial

TreeListColumnProps

The props of the columns of the TreeList component.

NameTypeDefaultDescription

cell?

any

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 the custom CSS classes to the column cells.

columnMenu?

any

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

editCell?

any

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

The field to which the column is bound.

filter?

any

Deprecated. Use filterCell prop instead.

filterCell?

any

Defines the component that will be rendered as a filter cell.

format?

string

The format that is applied to the value before it is displayed. 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 the supported date and number formats, refer to the kendo-intl documentation.

headerCell?

any

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

headerClassName?

string

Sets the custom CSS classes to the column header cell.

headerSelectionValue?

boolean

Defines if the header selection checkbox is checked.

id?

string

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 id automatically.

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

The width of the column (in pixels) below which the user is not able to resize the column through the UI. Defaults to 10.

orderIndex?

number

Determinates the position of the column. Columns with smaller orderIndex will appear before columns with bigger orderIndex. Defaults to 0.

reorderable?

boolean

Indicates whether the column is reorderable.

resizable?

boolean

Indicates whether the column is resizable.

sortable?

ColumnSortSettings

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

title?

string

The title of the column.

width?

string | number

The width of the column (in pixels).