Components/TreeSelect
Universal Component

TreeSelect

Component documentation for TreeSelect.

This page was migrated by AI, please review carefully

Migration is complete, but please validate against source code and manual review.

TreeSelect

Component documentation for TreeSelect.

Basic Usage

TreeSelect

Demo loads on client.

Notes

  • When multiple is true, modelValue must be an array; clearing returns an empty array.
  • When multiple is false, clearing returns undefined.

API

TxTreeSelect Props

PropTypeDefaultDescription
modelValuestring | number | Array<string | number> | undefined-TextValue(v-model)
nodesTreeSelectNode[][]Description for nodes.
multiplebooleanfalseDescription for multiple.
disabledbooleanfalseDescription for disabled.
placeholderstring'Text'Description for placeholder.
searchablebooleantrueDescription for searchable.
clearablebooleantrueDescription for clearable.
placementPopoverPlacement'bottom-start'Description for placement.
dropdownOffsetnumber6Description for dropdownOffset.
dropdownWidthnumber0Description for dropdownWidth.
dropdownMaxWidthnumber480Description for dropdownMaxWidth.
dropdownMaxHeightnumber320Description for dropdownMaxHeight.
defaultExpandedKeysArray<string | number>[]DefaultText key

TreeSelectNode

FieldTypeDescription
keystring | numberDescription for key.
labelstringDescription for label.
disabledbooleanDescription for disabled.
childrenTreeSelectNode[]Description for children.

Events

EventParamsDescription
update:modelValue(v)Description for update:modelValue.
change(v)Description for change.
open-Description for open.
close-Description for close.

Slots

NameDescription
nodeDescription for node.

Expose

NameTypeDescription
open()() => voidDescription for open().
close()() => voidDescription for close().
toggle()() => voidDescription for toggle().
focus()() => voidDescription for focus().
blur()() => voidDescription for blur().
clear()() => voidDescription for clear().
setValue(v)(v) => voidDescription for setValue(v).
getValue()() => anyDescription for getValue().
getCheckedKeys()() => Array<string | number>Text key(Text)
Was this helpful?