# Voice Node (Notchset): prompt.md (v1.0.0)

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

A 64-spoke voice ring that listens to your mic's level, sweeps while thinking and beats while speaking, with a transcript that arrives word by word, mute and a footer that says what the mic is doing.

## 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/voice-node.tsx`; shared code: `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: `VoiceNode`, 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 { VoiceNode, type VoiceState } from "@/components/ui/notchset/voice-node";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `VoiceNode` | `voice-node` | Header, node, transcript and controls. |

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/voice-node.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
- voice, voice agent, mic, speech, listening, assistant, audio visualiser, Notchset
- The surface for a voice agent session

### Not when
- Recording messages: use Voice Notes

## Mistakes
- The mic is level only; nothing is recorded. Pass mic={false} to skip the prompt

## Usage

```tsx
"use client";

import * as React from "react";
import { VoiceNode, type VoiceState } from "@/components/ui/notchset/voice-node";

/** Wire state and transcript to your voice agent; the node handles the mic level, mute and the ring. */
export function VoiceAgent({ connect }: { connect: (handlers: { onState: (s: VoiceState) => void; onUser: (t: string) => void; onAgent: (t: string) => void }) => () => void }) {
  const [state, setState] = React.useState<VoiceState>("ready");
  const [heard, setHeard] = React.useState("");
  const [reply, setReply] = React.useState("");
  const stop = React.useRef<(() => void) | null>(null);
  return (
    <VoiceNode
      state={state}
      user={heard}
      agent={reply}
      onStart={() => {
        setHeard("");
        setReply("");
        stop.current = connect({ onState: setState, onUser: setHeard, onAgent: setReply });
      }}
      onEnd={() => {
        stop.current?.();
        setState("ready");
      }}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `state` | `'ready' \| 'listen' \| 'think' \| 'speak'` |  | Your agent's phase. |
| `user / agent` | `string` |  | Transcript so far; new words animate in. |
| `onStart / onEnd / mic` | `() => void / () => void / boolean` |  | Session control; mic level on by default. |

Full docs: https://beautiful-ui.dev/components/voice-node

## 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 / Space | Start or end on the node |
| Tab | Mute, then End |

## Performance

- Three paths rewritten per frame, no React renders; pauses off screen.

## Responsive

- The node is 260px, shrinking with its card.

## Motion inventory

| Interaction | What moves |
|---|---|
| Levels | Spokes ease toward their targets each frame (rise ×.4, fall ×.1), drawn through refs |
| Words | Each fades and rises 4px as it arrives |

## Accessibility contract (preserve when editing)
- The node is a button (Start / End voice chat); the status is announced politely; mute is aria-pressed

## Install

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

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.