# Text Reveal (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-text-reveal` · version 1.0.0 · component · pro (Pro)
- 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-text-reveal`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-text-reveal
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A heading or a line of copy that settles in the first time it scrolls into view: words, or the lines they wrap into, rise a little out of a soft blur, once, and then it's just text.

## 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/controls/text-reveal.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: `TextReveal`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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`). Never add Tailwind colour classes inside the component.

```tsx
import { TextReveal } from "@/components/ui/lumen/controls/text-reveal";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `TextReveal` | — | The text, split into words that reveal. |

## 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/controls/text-reveal.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
- text reveal, reveal on scroll, animated heading, scroll animation, fade in text, hero heading
- A section heading or a short statement on a landing or changelog page
- One line that deserves a beat of attention as it arrives

### Not when
- Body text, forms or anything people read to act: animation slows reading
- More than one or two per screen

## Mistakes
- Don't reveal text people need right away (prices, errors, form labels)
- Pass plain text: markup inside is not supported

## Usage

```tsx
import { TextReveal } from "@/components/ui/lumen/controls/text-reveal";

export function SectionHeading() {
  return (
    <TextReveal as="h2" className="text-3xl font-semibold tracking-tight">
      Every number on one page, and the reason it moved.
    </TextReveal>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `children` | `string` |  | The text: a string, so it can be split into words. |
| `as` | `"p" \| "h1" \| "h2" \| "h3" \| "h4" \| "span" \| "div"` | `"p"` | The element. |
| `by` | `"word" \| "line"` | `"word"` | Word by word, or line by line as the text wraps at its width. |
| `stagger / delay` | `number` | `0.04 or 0.1 / 0` | Seconds between words or lines, and before the first. |
| `amount` | `number` | `0.35` | How much must be in view before it starts. |
| `motion` | `"full" \| "subtle" \| "off"` | `"full"` | full: rise out of a blur; subtle: a fade; off: no reveal. Reduced motion is off. |

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

## Customising
- Motion: `motion="full"` (default) | `"subtle"` | `"off"`. prefers-reduced-motion is always respected.
- 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 | Not focusable |

## Motion inventory

| Interaction | What moves |
|---|---|
| Scrolls into view | Each word rises .38em out of a 6px blur over 700ms, 40ms apart; once only |

## Accessibility contract (preserve when editing)
- The text is in the server HTML and visible without JavaScript; it is hidden only once the reveal is armed
- Reduced motion shows the text at once
- Copying gives the original text, spaces and all

## Install

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

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.