# Treemap (Notchset): prompt.md (v1.0.0)

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

A squarified treemap of groups and leaves, shaded in five steps from field to ink, with labels where they fit; clicking a group zooms it to the whole area while boxes glide, and Esc zooms out.

## 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/treemap.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/chart-geometry.ts`.
- 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: `Treemap`, `TreemapScale`, `squarify`, 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 { Treemap, TreemapScale, type TreemapGroup } from "@/components/ui/notchset/treemap";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Treemap` | `treemap` | The map. |
| `TreemapScale` | — | Five-step legend. |
| `squarify` | — | The layout. |

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/treemap.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
- treemap, hierarchy, spend breakdown, nested shares, drill down, Notchset
- Two-level breakdowns: spend by agent then tool

### Not when
- One level: use Donut or Waffle

## Mistakes
- Shade is 0–1; it maps to five steps

## Usage

```tsx
import { Treemap, TreemapScale, type TreemapGroup } from "@/components/ui/notchset/treemap";

// shade: 0–1, here the change vs last month (0.5 is flat).
const spend: TreemapGroup[] = [
  { label: "Planner", children: [{ label: "search_docs", value: 3.4, shade: 0.6, sub: "+12% VS AUG" }, { label: "web_fetch", value: 1.9, shade: 1, sub: "+38% VS AUG" }] },
  { label: "Triage", children: [{ label: "classify", value: 2.2, shade: 0.55 }, { label: "other", value: 0.8, shade: 0.3 }] },
];

export function SpendMap() {
  return <Treemap data={spend} format={(v) => `$${v}K`} rootLabel="ALL AGENTS" legend={<>CHANGE VS AUG <TreemapScale /></>} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data` | `{ label, children: { label, value, shade, sub?, detail? }[] }[]` |  | Groups and leaves; shade 0–1. |
| `format` | `(v) => string` |  | Values. |
| `rootLabel / hint / legend` | `ReactNode` |  | Breadcrumb root, readout hint, legend. |

Full docs: https://beautiful-ui.dev/components/treemap

## 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 |
|---|---|
| Enter | Zoom into a group (its header) |
| Esc | Zoom out |

## Performance

- HTML boxes placed by percent.

## Responsive

- Keeps an 880 × 400 aspect.

## Motion inventory

| Interaction | What moves |
|---|---|
| Zoom | Boxes move and resize together (560ms); others fade |

## Accessibility contract (preserve when editing)
- Group headers are buttons; the readout describes the hovered leaf

## Install

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

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.