# Stepper (Notchset): prompt.md (v1.0.0)

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

A stepper whose connector traces to the next node before it lights: rings, popping dots and drawn checks, horizontal or vertical, with each step's content sliding in the direction of travel.

## 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/stepper.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: `Stepper`, `StepNode`, 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 { Stepper, type StepperStep } from "@/components/ui/notchset/stepper";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `Stepper` | `stepper` | The steps. |
| `StepNode` | — | The 24px node, for your own layouts. |

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/stepper.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
- stepper, wizard, multi-step form, onboarding steps, deploy flow, progress steps, Notchset
- A short linear flow where each step must be ready before the next

### Not when
- Free navigation between sections: use Tabs

## Mistakes
- Gate Continue in your footer: the stepper shows state, it doesn't block

## Usage

```tsx
"use client";

import * as React from "react";
import { Stepper, type StepperStep } from "@/components/ui/notchset/stepper";

const steps: StepperStep[] = [
  { label: "Connect", description: "Add your API key" },
  { label: "Pick agents", description: "Planner, Triage" },
  { label: "Run evals", description: "1,200 cases" },
];

export function Onboarding() {
  const [step, setStep] = React.useState(1);
  return (
    <div className="grid gap-3">
      <Stepper steps={steps} value={step} orientation="horizontal" />
      <button type="button" onClick={() => setStep((s) => Math.min(steps.length, s + 1))}>
        Next
      </button>
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `steps` | `{ label, description?, content? }[]` |  | The steps and what each shows. |
| `value` | `number` |  | The current step. |
| `complete` | `boolean` |  | Every step done. |
| `orientation` | `"horizontal" \| "vertical"` |  | Content below a rule, or inline under the current step. |

Full docs: https://beautiful-ui.dev/components/stepper

## 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 |
|---|---|
| Tab | Into the current step's content, then your footer |

## Performance

- CSS transitions; content swaps once per step.

## Responsive

- Horizontal labels never wrap; use vertical in narrow spaces.

## Motion inventory

| Interaction | What moves |
|---|---|
| Forward | The connector traces (420ms), then the next ring inks (380ms in) and its dot pops (420ms in); the finished node fills and its check draws |
| Back | Undoes at once |
| Content | Slides 14px away (110ms) and settles in from the other side (380ms) |
| Vertical | The current step's content unrolls (380ms) |

## Accessibility contract (preserve when editing)
- An ordered list; the current step has aria-current="step"
- Put your status line in an aria-live region

## Install

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

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.