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

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

Code in a recessed readout: the filename and language in its header, a copy button with a soft cue, line numbers as dim mono digits, and highlighted lines lit by a filament down their edge. Plain text by default; pass pre-highlighted lines (Shiki on the server) for colour.

## 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/code-block.tsx`; shared code: `lib/beautiful-ui/lumen/glyphs.tsx`, `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: `CodeBlock`, `CodeBlockCopy`, 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-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { CodeBlock } from "@/components/ui/lumen/code-block";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `CodeBlock` | `code-block` | Header, lines and copy. |
| `CodeBlockCopy` | `code-block-copy` | The copy button, on its own. |

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/code-block.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
- code block, code snippet, syntax highlighting, copy code, install command, api example, docs code, Lumen
- Install commands and API examples in docs
- Code in AI answers and changelogs

### Not when
- A word of code inside a sentence: use <code> in Typography
- Editable code: use an editor

## Mistakes
- Highlight on the server: don't ship a highlighter to every page
- Light only the lines you talk about

## Usage

```tsx
import { CodeBlock } from "@/components/ui/lumen/code-block";

<CodeBlock filename="track.ts" language="ts" highlight={[3]} code={`import { lumen } from "@lumen/sdk";

lumen.track("report_exported", { charts: 12 });`} />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `code` | `string` |  | The source (Copy copies this). |
| `language / filename` | `string` |  | Shown in the header. |
| `highlight` | `number[]` |  | 1-based lines to light. |
| `showLineNumbers / wrap` | `boolean` | `true / false` | Numbers; wrap instead of scroll. |
| `lines` | `ReactNode[]` |  | Pre-highlighted markup per line, e.g. from Shiki's codeToHast on the server. |

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

## 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 |
|---|---|
| Tab | Reaches the copy button |
| Enter | Copy |

## Motion inventory

| Interaction | What moves |
|---|---|
| Copy | The icon turns to a lit check; a soft cue |

## Accessibility contract (preserve when editing)
- A figure with its filename as the caption
- Line numbers are hidden from screen readers and selection
- The copy button says Copied

## Install

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

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.

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.