# Tree View (Notchset): prompt.md (v1.0.0)

- id: `tree-view` · version 1.0.0 · component · pro (Pro)
- category: Navigation
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/tree-view`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/tree-view
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A file tree with depth rails, status boxes (modified, added, changed counts), children that grow in staggered as folders open, an ink selection, and the full WAI-ARIA tree keyboard.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/notchset/tree-view.tsx`; shared code: `lib/beautiful-ui/notchset/tree.tsx`, `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/calendar.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `TreeView`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

```tsx
import { TreeView, type TreeItem } from "@/components/ui/notchset/tree-view";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `TreeView` | `tree-view` | The tree. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/tree-view.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- tree view, file tree, explorer, folder tree, repository browser, hierarchy, Notchset
- Browsing a hierarchy: files, folders, nested resources

### Not when
- Data with keys and values: use JSON Viewer

## Mistakes
- Paths are names joined by /: keep sibling names unique

## Usage

```tsx
import { TreeView, type TreeItem } from "@/components/ui/notchset/tree-view";

const repo: TreeItem[] = [
  {
    name: "relay",
    children: [
      { name: "agents", children: [{ name: "planner.ts", status: "M", lines: 214 }, { name: "triage.ts", lines: 98 }] },
      { name: "evals", children: [{ name: "planner-core.yaml", status: "+", lines: 40 }] },
      { name: "README.md", lines: 62 },
    ],
  },
];

export function RepoTree() {
  return <TreeView items={repo} title="RELAY" subtitle="/ MAIN" defaultExpanded={["relay"]} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `items` | `{ name, status?, lines?, children? }[]` |  | The tree. |
| `title / subtitle` | `ReactNode` |  | The header, with the changed count. |
| `defaultExpanded / defaultSelected` | `string[] / string` |  | Paths like relay/agents. |
| `onSelect` | `(path) => void` |  | On selection. |
| `describe` | `(node) => string` |  | The footer's detail. |

Full docs: https://beautiful-ui.dev/components/tree-view

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| ↑ / ↓ | Move |
| → | Open, or the first child |
| ← | Close, or the parent |
| Home / End | First / last |
| Enter / Space | Toggle |

## Performance

- Every node renders (hidden ones at 0px); fine to a few hundred.

## Responsive

- Names truncate; fills its container.

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Children grow to 30px (260ms), 18ms apart (at most 240ms), fading in 60ms later; the chevron turns 90° |
| Close | Rows fold (200ms) |

## Accessibility contract (preserve when editing)
- role=tree with treeitems, aria-level, aria-expanded and roving tabindex
- Status boxes have labels (modified, added)

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/tree-view
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- Built on shadcn/ui (https://ui.shadcn.com)

The notchset foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/notchset-foundation.json.