TreeListProps

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

Name	Type	Default	Description
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.
editField?	string		Specifies the name of the field which will provide a Boolean representation of the edit state of the current item (more information and examples).
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.
onColumnreorder?	(event: TreeListColumnReorderEvent) => void		Fires when the columns are reordered.
onDatastatechange?	(event: TreeListDataStateChangeEvent) => void		Fires when the data state of the TreeList is changed.
onExpandchange?	(event: TreeListExpandChangeEvent) => void		Fires when the user clicks on the expand or collapse icon of a row.
onFilterchange?	(event: TreeListFilterChangeEvent) => void		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.
onItemchange?	(event: TreeListItemChangeEvent) => void		Fires when the user changes the values of the item. The event is not debounced and fires on every onChange event of the input in the current EditCell (more information and examples).
onKeyDown?	(event: TreeListKeyDownEvent) => void		Fires when the user press keyboard key.
onPagechange?	(event: TreeListPageChangeEvent) => void		Fires when the page of the TreeList is changed.
onRowblur?	(event: TreeListRowEvent) => void		Fires when blur event is triggered on a row.
onRowclick?	(event: TreeListRowClickEvent) => void		Fires when the user clicks a row.
onRowcontextmenu?	(event: TreeListRowContextMenuEvent) => void		Fires when the user trigger the context menu of row.
onRowfocus?	(event: TreeListRowEvent) => void		Fires when focus event is triggered on a row.
onSelectionchange?	(event: TreeListSelectionChangeEvent) => void		Fires when the user tries to select or deselect a row or cell. (more information and example).
onSortchange?	(event: TreeListSortChangeEvent) => void		Fires when the sorting of the TreeList is changed (see example). You have to handle the event yourself and sort the data.
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.
reorderable?	boolean		If set to true, the user can reorder columns by dragging their header cells.
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.
rowRender?	any		Fires when a row is about to be rendered. Useful for overriding the default rendering of the row.
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.
selectable?	TreeListSelectableSettings		The TreeList selectable settings.
selectedField?	string		Specifies the name of the field which will provide a Boolean representation of the selected state of the item (see example).
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.