# Command Palette (Notchset): prompt.md (v1.0.0)

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

Jump or act from the keyboard and see what will happen before Enter: fuzzy matching that favours word starts, prefix scopes for actions, runs and people, a preview of the selected result, and nested steps such as choosing a model.

## 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/command-palette.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`, `lib/beautiful-ui/notchset/blocks.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: `CommandPalette`, 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 { CommandPalette, type PaletteItem } from "@/components/ui/notchset/blocks/command-palette";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `CommandPalette` | `command-palette` | The trigger and the palette. |

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/command-palette.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
- command palette, command menu, cmd k, quick switcher, spotlight search, keyboard launcher, fuzzy search, Notchset
- Keyboard-first navigation and actions in an app with many objects (agents, runs, people)
- Actions that need a second choice (a model, a target) without leaving the keyboard

### Not when
- A search over thousands of records: filter on the server and pass the results in
- A site-wide docs search: a simpler palette fits

## Mistakes
- Keep titles short: the match highlights letters in the title only
- Return a confirmation from onRun so the result is said, not assumed

## Usage

```tsx
"use client";

import { CommandPalette, type PaletteItem } from "@/components/ui/notchset/blocks/command-palette";

const items: PaletteItem[] = [
  { id: "planner", group: "AGENTS", title: "Planner", glyph: "PL", kind: "AGENT", action: "OPEN AGENT" },
  { id: "pause", group: "ACTIONS", title: "Pause Planner", glyph: ">", kind: "ACTION", action: "PAUSE", prefix: ">", onRun: () => "PLANNER PAUSED" },
];

export function Commands() {
  return <CommandPalette items={items} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `items` | `{ id, group, title, glyph, round?, kind, meta?, description?, facts?, action, shortcut?, prefix?, step?, onRun? }[]` |  | Everything it can find. prefix makes an item answer to a scope; step opens nested items instead of running; onRun returns a confirmation. |
| `recent` | `string[]` |  | Ids shown under RECENT while the query is empty. |
| `scopes` | `Record<string, string>` | `{ ">": "ACTIONS", "#": "RUNS", "@": "PEOPLE" }` | Prefixes and the chip each shows. |
| `open / defaultOpen / onOpenChange` | `boolean` |  | ⌘K inside the block toggles it. |
| `triggerLabel / hint / placeholder` | `string` |  | The trigger, the line under it until something runs, and the input's hint. |

Full docs: https://beautiful-ui.dev/components/command-palette

## 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 |
|---|---|
| ⌘K / Ctrl+K | Open or close |
| ↑ ↓ | Move the highlight |
| Enter | Run the item or open its step (ignored while composing with an IME) |
| Esc / ⌫ on an empty step | Back out of a step, then close |

## Performance

- Matching runs over the items you pass on every keystroke; past a few hundred, filter on the server and pass the hits.

## Responsive

- The preview hides under 640px of block width; the dialog keeps 16px from the edges.

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Scales from .98 and fades (280ms) over a scrim; closes faster (180ms) |
| Highlight | One block glides between rows (160ms); the selected glyph inverts |
| Preview | Cross-fades as the selection moves (200ms) |
| Count | The result count rolls |

## Accessibility contract (preserve when editing)
- The palette is a modal dialog; its input is a combobox over a listbox with aria-activedescendant
- The preview is a labelled, polite live region; the confirmation under the trigger is announced
- Focus returns to the trigger when the palette closes

## Install

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

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.
