Treeview API

API reference for the Treeview components.

Explore these related pages for additional context and usage patterns.

Page	Category
Treeview	Disclosure
createNested	Selection
useRovingFocus	System
Expansion Panel	Disclosure

Treeview.Root

Props

namespace

string | undefined

Namespace for dependency injection

disabled

boolean | undefined

Disables the entire tree

enroll

boolean | undefined

Auto-select non-disabled items on registration

mandatory

boolean | "force" | undefined

Prevents deselecting the last selected item

multiple

boolean | undefined

Allows selecting multiple items

open

NestedOpenMode | undefined

Controls how nodes expand: 'multiple' (default) or 'single' (accordion)

openAll

boolean | undefined

Auto-expand all nodes on registration

reveal

boolean | undefined

Opening a node also opens all its ancestors

selection

NestedSelectionMode | undefined

Controls how selection cascades: 'cascade' (default), 'independent', or 'leaf'

active

NestedActiveMode | undefined

Controls active/highlight mode: 'single' (default) or 'multiple'

Events

update:model-value

[value: T | T[]]

Slots

default

TreeviewRootSlotProps

Treeview.Activator

Props

namespace

string | undefined

Namespace for dependency injection

Treeview.Checkbox

Props

namespace

string | undefined

Namespace for dependency injection

Treeview.Content

Props

namespace

string | undefined

Namespace for dependency injection

Treeview.Cue

Props

namespace

string | undefined

Namespace for dependency injection

Treeview.Indicator

Props

namespace

string | undefined

Namespace for dependency injection

Treeview.Item

Props

id

ID | undefined

Unique identifier (auto-generated if not provided)

value

V | undefined

Value associated with this item

disabled

MaybeRefOrGetter<boolean> | undefined

Disables this item

namespace

string | undefined

Namespace for dependency injection

Slots

default

TreeviewItemSlotProps<V>

Treeview.List

Props

namespace

string | undefined

Namespace for dependency injection

multiselectable

boolean | undefined

Whether multiple items can be selected (sets aria-multiselectable)

label

string | undefined

Accessible label for the tree

Treeview.SelectAll

Props

label

string | undefined

Optional display label (passed through to slot and aria-label)

disabled

boolean | undefined

Disables this checkbox

namespace

string | undefined

Namespace for dependency injection