# Text Reveal (Notchset): prompt.md (v1.0.0)

- id: `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/text-reveal`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/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 condensed headline revealed five ways: letters roll out of their cells, lines rise together, a rule traces and wipes each word open, words narrow from wide, or glyphs decode left to right.

## 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/notchset/text-reveal.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-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`, `headlineClass`, `useReplay`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet 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 `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

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

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `TextReveal` | `text-reveal` | The headline. |
| `useReplay` | — | pre → go timing, for your own pieces. |

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 `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/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, headline animation, hero title, split text, decode text, letter animation, Notchset
- A hero or section headline that should arrive with intent

### Not when
- Body copy or anything read twice a minute

## Mistakes
- The font needs its width axis (62–125%) for STRETCH

## Usage

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

<TextReveal lines={[["ATLAS", "3", "FLASH"], ["IS", "LIVE"]]} mode="roll" trigger="inView" />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `lines` | `string[][]` |  | Explicit lines of words. |
| `mode` | `"roll" \| "lines" \| "trace" \| "stretch" \| "decode"` |  | How it arrives. |
| `trigger` | `"mount" \| "inView" \| "manual"` |  | When it plays. |
| `replayKey` | `number` |  | Change it to replay. |
| `as` | `"h1" \| "h2" \| …` |  | The element (default h2). |

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

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- 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 |

## Performance

- CSS transitions; DECODE runs a 45ms interval only while playing.

## Responsive

- Lines never wrap: size the headline to fit its column.

## Motion inventory

| Interaction | What moves |
|---|---|
| ROLL | Letters rise from 105% in their cells (620ms), 26ms apart |
| LINES | Words rise from 108% (680ms), 150ms a line, 40ms a word |
| TRACE | A 3px rule draws (300ms), the word wipes open (380ms, +200ms), the rule fades (+640ms) |
| STRETCH | Words narrow from 125% (760ms) as they fade in, 80ms apart |
| DECODE | Glyphs cycle every 45ms; letter i lands at 160 + i × 55ms |

## Accessibility contract (preserve when editing)
- The heading carries the whole sentence as its label; letter spans are hidden from assistive tech
- Reduced motion shows the final text at once

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/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 notchset 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/notchset-foundation.json.