# JSON Viewer (Notchset): prompt.md (v1.0.0)

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

A JSON viewer with depth rails, previews on closed branches, search across keys and values that opens every ancestor of a match and steps between them, and the selected path to copy.

## 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/json-viewer.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: `JsonViewer`, 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 { JsonViewer } from "@/components/ui/notchset/json-viewer";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `JsonViewer` | `json-viewer` | The viewer. |

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/json-viewer.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
- json viewer, json tree, api response, payload inspector, object explorer, debug, Notchset
- Inspecting API responses, events and payloads

### Not when
- Editing JSON: use a code editor

## Mistakes
- Search opens branches only while it runs; clearing restores what was open

## Usage

```tsx
import { JsonViewer } from "@/components/ui/notchset/json-viewer";

const response = {
  id: "run_8f3a1",
  agent: "planner",
  status: "ok",
  latency_ms: 2104,
  tools: [{ name: "search_docs", calls: 3 }, { name: "run_sql", calls: 1 }],
  usage: { input_tokens: 1820, output_tokens: 412 },
};

export function RunResponse() {
  return <JsonViewer data={response} rootKey="run" defaultDepth={2} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `data` | `unknown` |  | Any JSON value. |
| `rootKey` | `string` |  | The root's name, and the start of each path. |
| `header` | `ReactNode` |  | A line above the search (the request). |
| `defaultExpanded / defaultDepth` | `string[] / number` |  | What starts open. |
| `defaultSelected` | `string` |  | A path like run.usage.cost_usd. |
| `height` | `number` |  | The scroll area (312px). |

Full docs: https://beautiful-ui.dev/components/json-viewer

## 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 |
|---|---|
| ↑ / ↓ / → / ← | Tree moves |
| Enter / ↓ in search | Next match |
| Shift Enter / ↑ | Previous match |
| Esc in search | Clear |

## Performance

- Every node renders: virtualise past ~2,000.

## Responsive

- Fills its container; long values stay on one line and scroll.

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Rows grow in staggered, as Tree View |
| Match | The view scrolls the current match to the centre |

## Accessibility contract (preserve when editing)
- role=tree with the tree keys; the match count is live
- Matches are marked text, not only colour

## Install

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

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.