# Assistant Panel (Notchset): prompt.md (v1.0.0)

- id: `assistant-panel` · version 1.0.0 · block · 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/assistant-panel`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui/segmented-control, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/assistant-panel
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

An assistant docked inside a product page, built for answers you can check: each answer names what it read and shows its query, every number in it shows its source on hover, and changing the scope reruns the answer in place.

## 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/blocks/assistant-panel.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `segmented-control`, `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: `AssistantPanel`, 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-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { AssistantPanel, type AssistantMessage } from "@/components/ui/notchset/blocks/assistant-panel";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `AssistantPanel` | `assistant-panel` | The block: header with scope, the thread, follow-ups and the composer. |

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/blocks/assistant-panel.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
- assistant panel, AI sidebar, ask your data, copilot panel, answers with sources, cited numbers, AI side panel, Notchset
- An assistant beside a dashboard or record page that answers from the data on it
- Answers whose numbers people will act on and need to check

### Not when
- A full-page assistant with history: use Chat App
- Free-form chat with no data behind it

## Mistakes
- Pass the new values when the scope changes, keeping each message's id: the numbers roll only if the answer stays mounted
- Give each number its source and rows: the popover is what makes the answer checkable

## Usage

```tsx
"use client";

import * as React from "react";
import { AssistantPanel, type AssistantMessage } from "@/components/ui/notchset/blocks/assistant-panel";

const scopes = [
  { value: "7d", label: "7D" },
  { value: "30d", label: "30D" },
];

export function AskPanel() {
  const [scope, setScope] = React.useState("7d");
  const messages: AssistantMessage[] = [
    { id: "q", role: "user", text: "How much did the migration save?" },
    {
      id: "a",
      role: "assistant",
      status: "done",
      source: { before: "CHECKED", count: "31,406", after: "RUNS" },
      parts: ["It saved ", { value: "$40.83", source: "runs × (0.0020 − 0.0007)", rows: "31,406 RUNS" }, " this week."],
    },
  ];
  return <AssistantPanel title="Ask Relay" scopes={scopes} scope={scope} onScopeChange={setScope} messages={messages} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `title / subtitle` | `string` |  | The header: what it is and what it answers from. |
| `scopes / scope / onScopeChange` | `{ value, label }[] / string` |  | The time scope (a Segmented Control). On change, pass the answers' new values: every number rolls to them. |
| `messages` | `({ id, role: 'user', text } \| { id, role: 'assistant', status, source?, query?, parts })[]` |  | parts mixes text and data tokens ({ value, source, rows }); grow it as the answer streams. |
| `scopeNote` | `string` |  | Under each finished answer: what the scope is and that it updates. |
| `followUps` | `string[]` |  | Chips above the composer; disabled while an answer streams. |
| `onAsk / onNewThread` | `(text) => void / () => void` |  | Asking (send, Enter or a follow-up) and starting over. |
| `placeholder / inputLabel` | `string` |  | The composer's hint and accessible name. |

Full docs: https://beautiful-ui.dev/components/assistant-panel

## 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 |
|---|---|
| Tab | Scope, the thread, the numbers in each answer, follow-ups, the composer |
| ← → | Change the scope |
| Enter | Ask (ignored while composing with an IME); open or close a query |
| Esc | Close a number's source |

## Performance

- Plain DOM; numbers roll with CSS transforms. Nothing animates per frame.

## Responsive

- Designed at 420px and fills its container; user messages wrap at 84% of the width.

## Motion inventory

| Interaction | What moves |
|---|---|
| Scope | The thumb stretches (340ms); every number rolls to its new value and the answer flashes the highlight (700ms) |
| Query | Opens on grid rows (340ms), closes faster (220ms) |
| New answer | The scanner while checking, then the words as you stream them |
| Source | The popover rises in (180ms) |

## Accessibility contract (preserve when editing)
- The thread is a log (focusable); an answer is aria-busy until it is done
- The source line is a button that expands the query (aria-expanded)
- Each data token is focusable and describes itself with its source tooltip while open; Esc closes it
- The scope is a radio group with arrow keys (Segmented Control)

## Install

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

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.
