TreeViewProps
Represents the props of the Kendo UI for Vue TreeView component.
Definition
Package:@progress/kendo-vue-treeview
Properties
animate?
boolean
Sets whether the TreeView animates the expanding and collapsing of items.
true
ariaLabel?
string
Sets the accessible name of the TreeView (more on accessibility by the TreeView).
ariaLabelledby?
string
Sets the id of the element or elements that label the TreeView (more on accessibility by the TreeView).
ariaMultiSelectable?
string | boolean
Sets the aria-multiselectable attribute of the TreeView. Set it to true when the user can select more than one item
(more on accessibility by the TreeView).
checkboxes?
boolean
Sets whether the TreeView renders checkboxes (see example). By default, the TreeView does not render checkboxes.
checkField?
string
Sets the data item field that holds the checked state of the item as a boolean.
checked
checkIndeterminateField?
string
Sets the data item field that holds the indeterminate check state of the item as a boolean.
checkIndeterminate
childrenField?
string
Sets the data item field that holds the children of the item as an array.
items
dataItems?
any[]
Sets the data of the TreeView (more information and examples).
disableField?
string
Sets the data item field that holds the disabled state of the item as a boolean.
disabled
draggable?
boolean
Sets whether the TreeView fires the drag events (see example). By default, the TreeView does not fire the drag events.
expandField?
string
Sets the data item field that holds the expanded state of the item as a boolean.
expanded
expandIcons?
boolean
Sets whether the TreeView renders the expand and collapse icons (see example). By default, the TreeView does not render the icons.
focusIdField?
string
Sets the data item field that uniquely identifies the focused item.
The TreeView has built-in focus and keyboard navigation. By default, it uses hierarchical indices to find the focused item.
Use focusIdField to set a field that the TreeView uses instead of the hierarchical index.
Sets a function that returns the hierarchical index of the focused item.
When you set focusIdField, the TreeView runs a depth-first search on the data to find the focused item.
Use getFocusHierarchicalIndex to replace this default search.
string
hasChildrenField?
string
Sets the data item field that tells the TreeView that an item has children, even when you do not pass the children yet. Use it to load data on demand (see example).
hasChildren
id?
string
Sets the unique id of the TreeView. The TreeView uses it to build the id values of its items.
When you do not set it, the TreeView generates a unique id.
item?
any
Sets a custom template for each TreeView item (see example).
Accepts a Vue component, a render function, or a slot name.
onCheckChange?
(event: TreeViewCheckChangeEvent) => void
Fires when the user clicks a checkbox or presses Space on a focused item (see example).
onExpandChange?
(event: TreeViewExpandChangeEvent) => void
Fires when the user expands or collapses an item (see example).
onItemClick?
(event: TreeViewItemClickEvent) => void
Fires when the user clicks an item or presses Enter on a focused item (see example).
onItemDragEnd?
(event: TreeViewItemDragEndEvent) => void
Fires when the user drops a dragged item (see example).
onItemDragOver?
(event: TreeViewItemDragOverEvent) => void
Fires when the user moves a dragged item (see example).
onItemDragStart?
(event: TreeViewItemDragStartEvent) => void
Fires when the user starts to drag an item.
selectField?
string
Sets the data item field that holds the selected state of the item as a boolean.
selected
size?
"small" | "medium" | "large"
Sets the size of the TreeView.
The available options are:
- small
- medium
- large
- undefined—Does not set a size
className.
undefined
tabIndex?
number
Sets the tabindex attribute of the TreeView element.
textField?
string
Sets the data item field that holds the text of the item.
text