# QR Code (Lumen Halo): prompt.md (v1.0.0)

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

A QR code drawn as rounded cells on a light plate, its finder eyes tinted with your accent, that exposes along the diagonal like a scan whenever the value changes. Dark on light in both themes so every camera reads it; an optional logo sits in a cleared centre with error correction raised to cover it.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: `uqr@^0.1`.
- Files: `components/ui/lumen/qr-code.tsx`.
- 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: `QrCode`, 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-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { QrCode } from "@/components/ui/lumen/qr-code";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `QrCode` | `qr-code` | The code. |

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/qr-code.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
- qr code, qr, share link, open on phone, scan, 2fa setup, wifi qr, ticket code, Lumen
- Handing a link from a desktop to a phone: share, sign in, pair a device
- Authenticator setup (otpauth:// URLs)

### Not when
- Printing codes at scale: generate images on the server
- A link people can simply click

## Mistakes
- Keep the plate tone for anything that must scan reliably
- Don't shrink below ~120px for long URLs
- Test your logo size: the centre is cleared, not overlaid

## Usage

```tsx
import { QrCode } from "@/components/ui/lumen/qr-code";

<QrCode value="https://lumen.app/kitelabs/revenue" logo={<img src="/mark.svg" alt="" />} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value` | `string` |  | What the code holds. |
| `size` | `number` | `176` | Width and height in px. |
| `ecc` | `"L" \| "M" \| "Q" \| "H"` | `"M" (or "H" with a logo)` | Error correction. |
| `logo` | `ReactNode` |  | A mark for the cleared centre. |
| `tone` | `"plate" \| "lit"` | `"plate"` | Dark cells on a light plate (safest), or glowing cells on dark. |
| `label` | `string` |  | Accessible name (defaults to the value). |
| `animate` | `boolean` | `true` | Expose the cells when the value changes. |

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

## 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 |
|---|---|
| — | Not interactive |

## Motion inventory

| Interaction | What moves |
|---|---|
| Value change | Cells expose along the diagonal, like a scan |

## Accessibility contract (preserve when editing)
- role="img" with the value (or your label) as its name
- Always show the link as text too: not everyone can scan

## Install

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

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
- uqr (https://github.com/unjs/uqr)

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.