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

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

A pane of smoked glass that slides from an edge, follows your finger and snaps; the page behind dims and softens as it opens, nested drawers stack with a peek, and the handle is a short lit filament. shadcn's Drawer, 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: `@base-ui/react@^1` (Base UI build); `vaul@^1` (Radix build).
- Files: `components/ui/lumen/drawer.tsx`; shared code: `lib/beautiful-ui/lumen/portal.ts`, `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `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: `Drawer / DrawerTrigger / DrawerClose`, `DrawerContent`, `DrawerHeader / DrawerTitle / DrawerDescription / DrawerFooter`, `DrawerSwipeHandle`, 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-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { Drawer, DrawerContent, DrawerDescription, DrawerFooter, DrawerHeader, DrawerTitle, DrawerTrigger } from "@/components/ui/lumen/drawer";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Drawer / DrawerTrigger / DrawerClose` | `drawer` | Root and triggers. |
| `DrawerContent` | `drawer-content` | The pane (with the overlay and viewport). |
| `DrawerHeader / DrawerTitle / DrawerDescription / DrawerFooter` | `drawer-header` | Inside. |
| `DrawerSwipeHandle` | `drawer-swipe-handle` | Base UI build: the handle. |

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/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
- drawer, bottom sheet, mobile sheet, action sheet, swipe to dismiss, snap points, shadcn drawer, Lumen
- Phones: actions, filters and details from the bottom edge
- Anything people should swipe away

### Not when
- Desktop side panels with forms: use Sheet
- Confirmations: use Alert Dialog

## Mistakes
- Keep a visible close for people who don't swipe
- Use Sheet on desktop; drawers are for touch

## Usage

```tsx
import { Drawer, DrawerContent, DrawerDescription, DrawerFooter, DrawerHeader, DrawerTitle, DrawerTrigger } from "@/components/ui/lumen/drawer";

<Drawer showSwipeHandle>
  <DrawerTrigger>Share</DrawerTrigger>
  <DrawerContent>
    <DrawerHeader><DrawerTitle>Share Revenue overview</DrawerTitle></DrawerHeader>
    <DrawerFooter>…</DrawerFooter>
  </DrawerContent>
</Drawer>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `swipeDirection` | `"down" \| "up" \| "left" \| "right"` | `"down"` | Base UI build: which edge (vaul: direction). |
| `snapPoints` | `(number \| string)[]` |  | Heights it rests at. |
| `showSwipeHandle` | `boolean` | `false` | Base UI build: the lit filament handle (the vaul build shows one on bottom drawers). |
| `modal` | `boolean` | `true` | Dim and lock the page. |

Full docs: https://beautiful-ui.dev/components/lumen-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 |
|---|---|
| Escape | Close |
| Tab | Moves within the drawer |

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Slides from its edge on a long ease; the page dims |
| Swipe | Follows the finger, then snaps or leaves |

## Accessibility contract (preserve when editing)
- A modal dialog: focus is trapped and returns to the trigger
- Escape closes; the title names it

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-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)
- Base UI Drawer (https://base-ui.com/react/components/drawer)
- vaul (https://vaul.emilkowal.ski)

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.