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

TreeListProps

Represents the props of the Kendo UI for Vue TreeList component.

NameTypeDefaultDescription

cellRender?

any

Fires when a cell is about to be rendered. Useful for overriding the default rendering of the cell.

columns?

TreeListColumnProps[]

A collection of TreeListColumnProps for creating columns.

columnVirtualization?

boolean

Enables the virtualization of the columns (see example). If enabled, the columns outside the viewport are not rendered.

dataItemKey?

string

Sets the TreeList row key prop to the value of this field in the dataItem. If not set, the dataItem index will be used for the row key, which might lead to row not updated during paging or scrolling.

dataItems?

any[]

Sets the data of the TreeList.

expandField?

string

Specifies the name of the field which will provide a Boolean representation of the expanded state of the item.

filter?

FilterDescriptor[]

The descriptors by which the data is filtered (more information and examples). This affects the values and buttons in the FilterRow of the TreeList.

filterable?

boolean

Enables the filtering of the columns with their field option set

filterOperators?

FilterOperators

The filter operators for the filters.

filterRow?

any

If set, it will be rendered instead of the default FilterRow TreeList component.

headerCellRender?

any

Fires when a header cell is about to be rendered. Useful for overriding the default rendering of the header cell.

navigatable?

boolean

If set to true, the user can use dedicated shortcuts to interact with the TreeList. By default, navigation is disabled and the TreeList content is accessible in the normal tab sequence.

noRecords?

any

Represents the component that will be rendered when the data property of the TreeList is empty or undefined.

pageable?

any

Configures the pager of the TreeList.

The available options are:

  • buttonCount: Number—Sets the maximum numeric buttons count before the buttons are collapsed.
  • info: Boolean—Toggles the information about the current page and the total number of records.
  • type: PagerType—Accepts the numeric (buttons with numbers)

and input (input for typing the page number) values.

  • pageSizes: Boolean or Array<number>—Shows a menu for selecting the page size.
  • previousNext: Boolean—Toggles the Previous and Next buttons.

pager?

any

The pager component that the TreeList will render.

reordableRows?

boolean

If set to true, the rows of the TreeList can be reordered.

rowClass?

Function

A function that returns a custom class applied to the row.

rowHeight?

number

Defines the row height and implements equal heights for all rows.

scrollable?

string

Defines the scroll mode of the TreeList.

The available options are:

  • none—Renders no scrollbar.
  • scrollable—Represents the default scroll mode of the TreeList.

Requires you to set the overflow and height (for vertical scrolling), or width (for horizontal scrolling) styles.

  • virtual—Enables the vertical virtual scrolling of the TreeList.

Requires you to set the overflow and height styles and rowHeight prop of the TreeList.

size?

string

medium

Configures the size of the TreeList.

The available options are:

  • small
  • medium

skip?

number

The number of records that will be skipped.

sort?

SortDescriptor[]

The descriptors by which the data is sorted. Applies the sorting styles and buttons to the affected columns.

sortable?

SortSettings

Enables sorting (see example).

subItemsField?

string

Specifies the name of the field which will provide an array representation of the item subitems.

tableProps?

any

A props object that will be passed to the underlying HTML table.

take?

number

The number of records that will be taken.

toolbar?

any

Represents the TreeList toolbar component.

wrapperStyle?

Object

The styles of the wrapper component.

Methods

onDataStateChange

Fires when the data state of the TreeList is changed.

Parameters

event

TreeListDataStateChangeEvent

onExpandChange

Fires when the user clicks on the expand or collapse icon of a row.

Parameters

event

TreeListExpandChangeEvent

onFilterChange

Fires when the TreeList filter is modified through the UI (more information and examples). You have to handle the event yourself and filter the data.

Parameters

event

TreeListFilterChangeEvent

onKeyDown

Fires when the user press keyboard key.

Parameters

event

TreeListKeyDownEvent

onPageChange

Fires when the page of the TreeList is changed.

Parameters

event

TreeListPageChangeEvent

onRowblur

Fires when blur event is triggered on a row.

Parameters

event

TreeListRowEvent

onRowclick

Fires when the user clicks a row.

Parameters

event

TreeListRowClickEvent

onRowcontextmenu

Fires when the user trigger the context menu of row.

Parameters

event

TreeListRowContextMenuEvent

onRowfocus

Fires when focus event is triggered on a row.

Parameters

event

TreeListRowEvent

onSortChange

Fires when the sorting of the TreeList is changed (see example). You have to handle the event yourself and sort the data.

Parameters

event

TreeListSortChangeEvent