# Command (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-command` · version 1.0.0 · component · pro (All-Access)
- category: Navigation
- build: Base UI (this item also ships a Radix build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-command`
- npm dependencies: cmdk@^1
- registry dependencies: utils, @beautiful-ui/lumen-dialog, @beautiful-ui/lumen-input-group, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-command
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A command menu on cmdk: search in a recessed well, results in smoked glass, and a lens of light that glides to the highlighted item with a lit filament on its edge. Opens inline or as a ⌘K palette pinned near the top, so filtering never moves the input. shadcn's Command, cut from Lumen glass.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `cmdk@^1`.
- Files: `components/ui/lumen/command.tsx`; shared code: `lib/beautiful-ui/lumen/glyphs.tsx`, `lib/beautiful-ui/lumen/indicator.ts`, `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-dialog`, `lumen-input-group`, `lumen-foundation`.
- Builds: separate Base UI and Radix files. 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: `Command`, `CommandDialog`, `CommandInput`, `CommandList / CommandEmpty`, `CommandGroup / CommandItem / CommandShortcut / CommandSeparator`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) 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 `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList, CommandShortcut } from "@/components/ui/lumen/command";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Command` | `command` | Root (cmdk). |
| `CommandDialog` | `command` | The palette in a Dialog. |
| `CommandInput` | `command-input` | The search well. |
| `CommandList / CommandEmpty` | `command-list` | Results, the lens, and the no-results line. |
| `CommandGroup / CommandItem / CommandShortcut / CommandSeparator` | `command-item` | Inside the list. |

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 `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/command.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 menu, command palette, cmd k, ⌘K, quick search, jump to, launcher, spotlight, shadcn command, Lumen
- A ⌘K palette: jump anywhere and run actions by name
- Searchable lists of actions inside a popover

### Not when
- Choosing a value in a form: use Combobox
- Site-wide search over records: build Global Search on it

## Mistakes
- Wire the ⌘K shortcut yourself (a keydown listener that toggles open)
- Give items keywords so synonyms match
- Keep results short: a palette isn't a report

## Usage

```tsx
import { CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList, CommandShortcut } from "@/components/ui/lumen/command";

<CommandDialog open={open} onOpenChange={setOpen}>
  <Command>
    <CommandInput placeholder="Search dashboards and actions…" />
    <CommandList>
      <CommandEmpty>Nothing matches.</CommandEmpty>
      <CommandGroup heading="Jump to">
        <CommandItem onSelect={() => go("/revenue")}>Revenue overview</CommandItem>
      </CommandGroup>
      <CommandGroup heading="Actions">
        <CommandItem>New dashboard<CommandShortcut>⌘N</CommandShortcut></CommandItem>
      </CommandGroup>
    </CommandList>
  </Command>
</CommandDialog>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value / onValueChange` | `string` |  | The highlighted item (cmdk). |
| `shouldFilter / filter` | `boolean / (value, search, keywords) => number` |  | cmdk filtering; turn it off to filter on the server. |
| `loop` | `boolean` | `false` | Arrow keys wrap around. |
| `keywords (CommandItem)` | `string[]` |  | Extra words that match the item. |
| `title / description (CommandDialog)` | `string` |  | Screen-reader name and description of the palette. |
| `showCloseButton (CommandDialog)` | `boolean` | `false` | A close button in the corner. |

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

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- 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 |
|---|---|
| ArrowUp / ArrowDown | Move the highlight |
| Enter | Run the highlighted item |
| Home / End | First / last item |
| Escape | Close the palette |

## Motion inventory

| Interaction | What moves |
|---|---|
| Highlight | The lens glides to the item; its filament stays lit on the leading edge |
| Filter | The lens jumps to the first match (no glide); the list eases to its new height |
| Open | The palette drops in near the top of the screen |

## Accessibility contract (preserve when editing)
- A combobox input controlling a listbox (cmdk); the highlighted item is aria-selected
- CommandDialog is a modal dialog with a screen-reader title
- Headings name each group

## Install

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

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)
- cmdk (https://cmdk.paco.me)

The lumen 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/lumen-foundation.json.