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

- id: `lumen-sheet` · 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-sheet`
- npm dependencies: @base-ui/react@^1
- registry dependencies: utils, @beautiful-ui/lumen-button, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-sheet
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Smoked glass that glides in from any edge on Lumen's spring, for settings, filters and details beside the page. shadcn's Sheet, 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); `radix-ui@^1` (Radix build).
- Files: `components/ui/lumen/sheet.tsx`; shared code: `lib/beautiful-ui/lumen/portal.ts`, `lib/beautiful-ui/lumen/glyphs.tsx`, `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-button`, `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: `Sheet`, `SheetTrigger`, `SheetContent`, `SheetHeader / SheetTitle / SheetDescription`, `SheetFooter`, `SheetClose`, 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 { Sheet, SheetContent, SheetDescription, SheetHeader, SheetTitle, SheetTrigger } from "@/components/ui/lumen/sheet";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Sheet` | `sheet` | Root. |
| `SheetTrigger` | `sheet-trigger` | Opens it. |
| `SheetContent` | `sheet-content` | The glass panel on its side. |
| `SheetHeader / SheetTitle / SheetDescription` | `sheet-header` | The heading. |
| `SheetFooter` | `sheet-footer` | Actions at the bottom. |
| `SheetClose` | `sheet-close` | Closes it. |

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/sheet.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
- sheet, side panel, drawer, slide over, filters panel, shadcn sheet, Lumen
- Details or settings beside the page: a filter panel, a record, a menu on phones
- A drop-in for shadcn's Sheet: same sides and parts

### Not when
- A short, focused task: use Dialog
- A phone sheet you swipe: use Drawer

## Mistakes
- Keep it under 420px wide on desktop; it's beside the page, not over it

## Usage

```tsx
import { Sheet, SheetContent, SheetDescription, SheetHeader, SheetTitle, SheetTrigger } from "@/components/ui/lumen/sheet";

<Sheet>
  <SheetTrigger>Filters</SheetTrigger>
  <SheetContent side="right">
    <SheetHeader>
      <SheetTitle>Filters</SheetTitle>
      <SheetDescription>Narrow the dashboard.</SheetDescription>
    </SheetHeader>
  </SheetContent>
</Sheet>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `SheetContent side` | `"top" \| "right" \| "bottom" \| "left"` | `"right"` | Where it glides in from. |
| `SheetContent showCloseButton` | `boolean` | `true` | The glass close button. |

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

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

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | Glides 24px in from its side on the spring |
| Close | A quick glide out |

## Accessibility contract (preserve when editing)
- A dialog underneath: focus trapped, returned on close
- Title and description name it

## Install

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

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.