ITreeviewProps

interface
Component Props

Full props contract for <OrigamTreeview>. Hierarchical tree with multi/single selection, expansion control, line guides, lazy-expand support, and the full color/bgColor/size/density surface.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

items
required
ITreeviewNode[]
Flat or nested array of tree nodes driving the render.
modelValue
string[] | string
Selected node id(s). Array for multi-select, string for single-select. Binds via v-model.
expandedValue
string[]
IDs of currently expanded branch nodes. Controlled via v-model:expandedValue.
selectMode
TTreeviewSelectMode
Selection strategy: none, single, or multiple.
selectableNodes
TTreeviewSelectableNodes
Which node types can be selected: all, leaf, or branch.
showLines
boolean
Render vertical guide lines connecting parent to children.
expandOnClick
boolean
Expand/collapse a branch node when the row label area is clicked (not just the chevron).
ariaLabel
string

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Multi-select treeview with guide lines

vue