File explorer
Navigate folders and files with expansion and roving focus.
Components / Data
A finite hierarchical collection with expansion, selection, roving focus, and typeahead.
Last changed in version 0.13.0: Add avatar groups and chips, expand the block gallery, and improve component colors, spacing, and motion.
Project files
Aurora web
bunx --bun @getweini/cli@latest add treeImport the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.
<script setup lang="ts">
import { ref } from 'vue'
import Tree from './components/ui/tree/Tree.vue'
import TreeGroup from './components/ui/tree/TreeGroup.vue'
import TreeItem from './components/ui/tree/TreeItem.vue'
import TreeItemTrigger from './components/ui/tree/TreeItemTrigger.vue'
const selected = ref<string>()
const expanded = ref<string[]>(['src'])
</script>
<template>
<Tree v-model="selected" v-model:expanded="expanded" aria-label="Project files">
<TreeItem value="src">
<TreeItemTrigger>src</TreeItemTrigger>
<TreeGroup>
<TreeItem value="app"><TreeItemTrigger>App.vue</TreeItemTrigger></TreeItem>
<TreeItem value="styles"><TreeItemTrigger>styles.css</TreeItemTrigger></TreeItem>
</TreeGroup>
</TreeItem>
</Tree>
</template>Tree renders all nested items in the DOM, so use VirtualList for very large flat collections. Arrow keys, Home and End, right-to-left navigation, and typeahead skip disabled nodes.
Navigate folders and files with expansion and roving focus.
Select one or several nodes within a finite hierarchy.
Nest TreeGroup within an expandable item and bind both selection and expansion.
<script setup lang="ts">
import { ref } from 'vue'
import Tree from './components/ui/tree/Tree.vue'
import TreeGroup from './components/ui/tree/TreeGroup.vue'
import TreeItem from './components/ui/tree/TreeItem.vue'
import TreeItemTrigger from './components/ui/tree/TreeItemTrigger.vue'
const selected = ref<string>()
const expanded = ref<string[]>(['src'])
</script>
<template>
<Tree v-model="selected" v-model:expanded="expanded" aria-label="Project files">
<TreeItem value="src">
<TreeItemTrigger>src</TreeItemTrigger>
<TreeGroup>
<TreeItem value="app"><TreeItemTrigger>App.vue</TreeItemTrigger></TreeItem>
<TreeItem value="styles"><TreeItemTrigger>styles.css</TreeItemTrigger></TreeItem>
</TreeGroup>
</TreeItem>
</Tree>
</template>An array model collects selections from different branches.
<script setup lang="ts">
import { ref } from 'vue'
import Tree from './components/ui/tree/Tree.vue'
import TreeGroup from './components/ui/tree/TreeGroup.vue'
import TreeItem from './components/ui/tree/TreeItem.vue'
import TreeItemTrigger from './components/ui/tree/TreeItemTrigger.vue'
const selected = ref<string[]>([])
</script>
<template>
<Tree v-model="selected" selection-mode="multiple" aria-label="Topics">
<TreeItem value="science">
<TreeItemTrigger>Science</TreeItemTrigger>
<TreeGroup>
<TreeItem value="physics"><TreeItemTrigger>Physics</TreeItemTrigger></TreeItem>
<TreeItem value="biology"><TreeItemTrigger>Biology</TreeItemTrigger></TreeItem>
</TreeGroup>
</TreeItem>
</Tree>
</template>Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.
| Name | Type or signature | Default | What it does |
|---|---|---|---|
modelValuemodel | TreeSelectionValue | undefined | Not set | Current value. Use v-model to keep it in sync with your page. |
defaultValueprop | TreeSelectionValue | undefined | Not set | Starting value when the parent does not control the value. |
expandedmodel | string[] | undefined | Not set | Current expanded value. Use the matching v-model binding to update it. |
defaultExpandedprop | string[] | undefined | Not set | Starting expanded state when the parent does not control it. |
selectionModeprop | TreeSelectionMode | undefined | "single" | Choose whether one or several items can be selected. |
dirprop | "ltr" | "rtl" | undefined | "ltr" | Set the text direction used for keyboard and layout behavior. |
update:modelValueevent | [value: TreeSelectionValue] | — | Requests a new model value from the parent. |
valueChangeevent | [value: TreeSelectionValue] | — | Emitted after this value or state changes. |
update:expandedevent | [value: string[]] | — | Requests a new expanded value from the parent. |
expandedChangeevent | [value: string[]] | — | Emitted after this value or state changes. |
defaultslot | () => unknown | Required | Content shown inside Tree. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | () => unknown | Required | Content shown inside TreeGroup. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
valueprop | string | Required | Value represented by this control or option. |
disabledprop | boolean | undefined | Not set | Prevent interaction and show the disabled state. |
textValueprop | string | undefined | Not set | Plain text used for search, typeahead, or an accessible label. |
defaultslot | () => unknown | Required | Content shown inside TreeItem. |
| Name | Type or signature | Default | What it does |
|---|---|---|---|
defaultslot | (props: { expanded: boolean; selected: boolean; disabled: boolean; }) => unknown | Required | Content shown inside TreeItemTrigger. |
// packages/frameworks/vue/components/tree/types.ts
// ------- TYPES -------
export type TreeSelectionMode = 'none' | 'single' | 'multiple'
export type TreeSelectionValue = string | string[]
export interface TreeProps {
modelValue?: TreeSelectionValue
defaultValue?: TreeSelectionValue
expanded?: string[]
defaultExpanded?: string[]
selectionMode?: TreeSelectionMode
dir?: 'ltr' | 'rtl'
}
export interface TreeItemProps {
value: string
disabled?: boolean
textValue?: string
}