# Detail Drawer (Lumen Halo): prompt.md (v1.0.0)

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

Open one record over its list without losing the list: heading and status, fields, related charts and activity, pinned actions, previous and next with J and K, full screen on phones, and focus back on the row when it closes.

## 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/detail-drawer.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-sheet`, `lumen-button`, `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: `DetailDrawer`, `DetailDrawerSection`, `DetailDrawerFields`, `DetailDrawerFooter`, 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`. Never add Tailwind colour classes inside the component.

```tsx
import { DetailDrawer, DetailDrawerFields, DetailDrawerFooter, DetailDrawerSection, useDetailDrawer } from "@/components/ui/lumen/controls/detail-drawer";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `DetailDrawer` | — | The drawer, heading, status and previous/next. |
| `DetailDrawerSection` | — | A titled section. |
| `DetailDrawerFields` | — | The record's fields. |
| `DetailDrawerFooter` | — | Pinned actions. |

## 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/detail-drawer.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
- detail drawer, record drawer, side panel, inspector, row details, master detail, next previous record, Lumen
- A table or list where people open one record, read or act on it, and go back or on to the next

### Not when
- Editing that needs the whole page: give the record its own route
- A short confirmation: use Alert Dialog

## Mistakes
- Keep the drawer for reading and quick actions; long edits deserve a page
- Keep the list mounted underneath, so scroll and filters survive

## Usage

```tsx
import { DetailDrawer, DetailDrawerFields, DetailDrawerFooter, DetailDrawerSection, useDetailDrawer } from "@/components/ui/lumen/controls/detail-drawer";

const drawer = useDetailDrawer(accounts, (a) => a.id);

{accounts.map((a) => (
  <tr key={a.id} {...drawer.rowProps(a.id)} onClick={() => drawer.open(a.id)}>…</tr>
))}
<DetailDrawer {...drawer.props} eyebrow="Account" title={drawer.record?.name}>
  <DetailDrawerSection title="Details">
    <DetailDrawerFields fields={[{ label: "ARR", value: "$184,000", mono: true }]} />
  </DetailDrawerSection>
  <DetailDrawerFooter><Button onClick={drawer.close}>Done</Button></DetailDrawerFooter>
</DetailDrawer>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `useDetailDrawer(records, getId)` | `hook` |  | List state: open(id), close(), record, rowProps(id) for each row, and props for the drawer (open, position, previous/next). |
| `title / eyebrow / description / status` | `ReactNode` |  | The record's heading, a small mono line above it, a line below, and a badge beside it. |
| `position` | `{ index: number; total: number }` |  | Shown as "3 of 24" and announced as it changes. |
| `onPrevious / onNext` | `() => void` |  | Step through the list; the buttons disable at either end. |
| `labels` | `{ previous?, next?, of? }` |  | Words, for i18n. |
| `DetailDrawerSection title` | `ReactNode` |  | A titled section (a labelled region). |
| `DetailDrawerFields fields` | `{ label, value, mono? }[]` |  | A two-column description list; mono for numbers and ids. |
| `DetailDrawerFooter` | `div` |  | Actions pinned to the bottom. |

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

## 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 |
|---|---|
| J / K | Next or previous record (not while typing in a field) |
| Escape | Close and return to the row |
| Enter | Open a focused row (in your row handler) |

## Motion inventory

| Interaction | What moves |
|---|---|
| Open and close | Slides in from the edge on the spring; the record stays on show while it slides out |

## Accessibility contract (preserve when editing)
- A modal dialog named by the record's title; focus is trapped while it's open
- Closing returns focus to the row of the record last shown, even after stepping
- The position is a polite live region; previous and next say their shortcuts
- Sections are labelled regions; fields are a description list

## Install

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

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.