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

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

Images open over a smoked backdrop, growing out of the thumbnail you clicked. Click to zoom and the view follows your pointer; arrows, keys or a swipe move on; a filmstrip of cells lights the current image and a mono counter keeps your place.

## 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`.
- Files: `components/ui/lumen/lightbox.tsx`; shared code: `lib/beautiful-ui/lumen/glyphs.tsx`, `lib/beautiful-ui/lumen/portal.ts`, `lib/beautiful-ui/lumen/sound.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `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: `Lightbox`, `LightboxTrigger`, `LightboxGallery`, 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 { Lightbox, LightboxGallery, LightboxTrigger } from "@/components/ui/lumen/lightbox";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Lightbox` | `lightbox` | State and the viewer. |
| `LightboxTrigger` | `lightbox-trigger` | Opens an image. |
| `LightboxGallery` | `lightbox-gallery` | A ready grid of triggers. |

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/lightbox.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
- lightbox, image viewer, gallery, screenshots, photo zoom, image modal, media viewer, Lumen
- Screenshots, product shots or photos people want to see large
- A gallery where the order matters (release notes, a walkthrough)

### Not when
- One decorative image: link to it
- Video: use a player

## Mistakes
- Write real alt text: it is the dialog's title
- Pass small thumbnails for big galleries
- Don't put interactive content in captions

## Usage

```tsx
import { Lightbox, LightboxGallery, LightboxTrigger } from "@/components/ui/lumen/lightbox";

<Lightbox items={shots}>
  <LightboxGallery />
</Lightbox>

// Or your own thumbnails:
<Lightbox items={shots}>
  <LightboxTrigger index={0}><img src={shots[0].src} alt={shots[0].alt} /></LightboxTrigger>
</Lightbox>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `items` | `{ src; alt; caption?; thumbnail? }[]` |  | The images, in order. |
| `index / defaultIndex / onIndexChange` | `number` |  | Which image shows. |
| `open / defaultOpen / onOpenChange` | `boolean` |  | Whether the viewer is open. |
| `loop` | `boolean` | `true` | Wrap from the last image to the first. |
| `index (LightboxTrigger)` | `number` |  | The image the trigger opens. |

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

## 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 |
|---|---|
| ArrowLeft / ArrowRight | Previous / next image |
| Home / End | First / last |
| Escape | Close |

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | The image grows out of its thumbnail |
| Move | The next image develops in from a soft blur; the filmstrip cell lights |
| Zoom | 2x, following the pointer |

## Accessibility contract (preserve when editing)
- A modal dialog titled by the image's alt text; the caption is its description
- The counter is announced as you move
- Every control is a labelled button; focus returns to the thumbnail on close

## Install

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

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
- Base UI Dialog (https://base-ui.com/react/components/dialog)

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.