# Shortcut Recorder (Lumen Halo): prompt.md (v1.0.0)

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

Press it, then press the keys: held modifiers show as key caps at once, the first other key completes the combination, and a taken one is refused with what it's already used for.

## 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/lumen/controls/shortcut-recorder.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-kbd`, `lumen-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: `ShortcutRecorder`, `(field)`, `(status)`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { ShortcutRecorder } from "@/components/ui/lumen/controls/shortcut-recorder";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ShortcutRecorder` | — | The wrapper. |
| `(field)` | — | The button that records and shows the caps. |
| `(status)` | — | Refusals and warnings. |

## 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/controls/shortcut-recorder.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
- shortcut recorder, keyboard shortcut input, hotkey picker, keybinding, record shortcut, key combination, custom shortcuts settings
- Settings pages where people choose their own keyboard shortcuts
- Desktop-style apps, editors and tools with remappable commands

### Not when
- Showing a shortcut that can't change: use Kbd
- Touch-only products

## Mistakes
- Store the string and match it yourself: comboFromEvent(e).combo gives the same format from any KeyboardEvent
- Some combinations belong to the browser or OS (Cmd+W, Ctrl+Tab) and never reach the page: list them in conflicts

## Usage

```tsx
"use client";

import * as React from "react";
import { ShortcutRecorder } from "@/components/ui/lumen/controls/shortcut-recorder";

export function SearchShortcutSetting() {
  const [combo, setCombo] = React.useState("Meta+K");
  return (
    <div className="flex items-center justify-between gap-6">
      <span>Open search</span>
      <ShortcutRecorder aria-label="Open search" value={combo} onValueChange={setCombo} conflicts={{ "Meta+S": "Save", "Meta+P": "Print" }} />
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `aria-label` | `string` |  | What the shortcut does, e.g. "Open search". Names the control. |
| `value / defaultValue / onValueChange` | `string` |  | The combination as a string: modifiers in the order Ctrl, Alt, Shift, Meta, then the key ("Ctrl+Shift+K"). "" is none. |
| `conflicts` | `Record<string, string> \| (combo) => string \| null` |  | Combinations in use, with what they do. A taken one is refused and named. |
| `allowConflicts` | `boolean` | `false` | Save a taken combination anyway; the warning still shows. |
| `requireModifier` | `boolean` | `true` | Refuse a single key (Shift alone doesn't count); function keys are always fine. |
| `clearable / disabled` | `boolean` | `true / false` | A clear button (and Backspace) / off. |
| `labels` | `Partial<ShortcutRecorderLabels>` |  | Every word, for other languages. |

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

## 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 |
|---|---|
| Enter or Space | Start recording |
| Any combination | Record it (while recording) |
| Escape | Cancel recording |
| Backspace or Delete | Clear the shortcut |
| Tab | Stop recording and move on |

## Motion inventory

| Interaction | What moves |
|---|---|
| Recording | The rim lights, a red dot breathes and caps appear as keys are held; reduced motion keeps the dot still |

## Accessibility contract (preserve when editing)
- A button named with its action and current combination ("Open search: Meta K"); pressed while recording, with how to finish
- Refusals and warnings are in a status line linked to the button and announced
- Tab always leaves: it's never recorded on its own

## Install

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

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 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.