# Scroll Story (Notchset): prompt.md (v1.0.0)

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

A product loop told as steps you scroll through: a sticky rail whose fill follows the scroll and whose nodes jump to a step, the steps' text with inactive ones faded back, and a sticky panel whose layers cross-fade as the step changes; each panel gets whether it is active so it can play on entry.

## 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/blocks/scroll-story.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: `ScrollStory`, 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-glide`, `--notchset-ease-key-down`, `--notchset-ease-key-up`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-grow-to`, `--notchset-key-down`, `--notchset-key-up`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scan-to`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`, `--notchset-travel`). Never add Tailwind colour classes inside the component.

```tsx
import { ScrollStory } from "@/components/ui/notchset/blocks/scroll-story";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `ScrollStory` | `scroll-story` | Header, rail, steps and the panel. |

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/blocks/scroll-story.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
- scroll story, scrollytelling, how it works, product loop, step by step, sticky scroll, feature walkthrough, Notchset
- A 'how it works' section with three to five steps
- Showing a workflow where each step has something to see

### Not when
- A single feature: use Spotlight Grid or Feature Bento
- Long documentation: use the docs

## Mistakes
- Keep it to three to five steps; each needs something to show
- Make panels play on entry with the active flag, not on mount

## Usage

```tsx
import { ScrollStory } from "@/components/ui/notchset/blocks/scroll-story";

export function HowItWorks() {
  return (
    <ScrollStory
      title="From a failing run to a shipped fix"
      panelLabel="RELAY · PROD"
      steps={[
        { key: "CATCH", title: "A run fails", body: "Flagged before customers notice.", panel: (active) => <div>{active ? "Caught" : ""}</div> },
        { key: "SHIP", title: "Ship the fix", body: "Roll out by percent.", panel: () => <div>Rollout</div> },
      ]}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `steps` | `{ key, title, body, fact?, panel: (active) => node }[]` |  | Each step's text and its panel layer, told whether it is active. |
| `panelLabel` | `string` |  | The panel's header line. |
| `eyebrow / title / description` | `string / ReactNode / ReactNode` |  | The header. |

Full docs: https://beautiful-ui.dev/components/scroll-story

## 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 |
|---|---|
| ↑ ↓ / Page Up Page Down | Scroll the story |
| Tab then Enter | Jump to a step from the rail |

## Performance

- Scroll is read once per animation frame; panels decide their own cost.

## Responsive

- Under 760px (container width) the steps flow down the page with each panel under its text.

## Motion inventory

| Interaction | What moves |
|---|---|
| Rail | The ink fill follows the scroll; the current node grows |
| Panel | Layers cross-fade with a 12px move (520ms, 140ms after the step changes) |
| Steps | Inactive text fades to 30% |

## Accessibility contract (preserve when editing)
- The scroller is focusable, so the keyboard scrolls it; rail nodes are buttons named with their step and mark the current one (aria-current=step)
- Inactive panel layers are hidden and inert; the step label is announced as it changes
- Under 760px everything flows in page order with no inner scroller

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/scroll-story
```

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.