# Stage path (Notchset): prompt.md (v2.0.0)

- id: `stage-path` · version 2.0.0 · component · free
- category: Navigation
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/stage-path.json`
- npm dependencies: none
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/stage-path
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

Where a record is in its process: passed stages with their days, the current one solid, later ones grey. Press a stage to move the record there. A closed record ends in its outcome, Won or Lost, and how long it took..

## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: none beyond React.
- Files: `components/ui/notchset/stage-path.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `StagePath`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) 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.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- This item reads `--ns-bad`, `--ns-ease`, `--ns-font-display`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-ok`, `--ns-signal`, `--ns-text-meta`, `--ns-tint-ink`, `--ns-weight-medium`.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.

```tsx
import { StagePath } from "@/components/ui/notchset/stage-path";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/stage-path.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

### Not when

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import * as React from "react";
import { StagePath } from "@/components/ui/notchset/stage-path";

const STAGES = { Discovery: "#8f9bb3", Evaluation: "#38a6d6", Proposal: "#9b87f5", "Security review": "#e3a33b", Procurement: "#ec7d55" };
const DAYS = [6, 12, 1, 9, 4];

export default function StagePathDemo() {
  const [stage, setStage] = React.useState("Proposal");
  const stages = Object.entries(STAGES).map(([k, c], i) => ({ value: k, label: k, color: c, days: DAYS[i] }));
  return (
    <div className="flex w-full max-w-[640px] flex-col gap-4">
      <StagePath current={stage} onMove={setStage} stages={stages} />
      {/* a closed deal: the path ends in its outcome and how long it took */}
      <StagePath current="" onMove={() => {}} end={{ outcome: "won", label: "Won", detail: "in 32 days" }} reached={Object.keys(STAGES).slice(0, 4)} stages={stages.slice(0, 4)} />
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `stages` | `Stage[]` |  | Required. |
| `current` | `string` |  | Required. |
| `onMove` | `(value: string) => void` |  | Required. |
| `end` | `{ outcome: "won" \| "lost"; label: string; detail?: string \| undefined }` |  |  |
| `reached` | `string[]` |  |  |

Full docs: https://notchset.dev/components/stage-path

## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.

## Accessibility contract (preserve when editing)

## Install

```bash
npx shadcn@latest add https://notchset.dev/r/stage-path.json
```

Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/stage-path`. Every components.json style gets the same files.

## Continue the workflow

- [Board](https://notchset.dev/blocks/board)
- [Deal card](https://notchset.dev/blocks/deal-card)
- [Stage table](https://notchset.dev/blocks/stage-table)

## Source

### components/ui/notchset/stage-path.tsx

```tsx
// Notchset stage-path 2.0.0 · https://notchset.dev/changelog
"use client";
import * as React from "react";
import { cn } from "@/lib/utils";

/*
 * Stage path: where a record is in its process, and the way to move it. Passed stages are a soft tint of the
 * current stage's colour with the days spent there, in words; the current stage is solid with a halo; later stages are
 * grey. The current stage says how long it has been there, in its colour. Press a stage to move the record there. On a phone only the current stage's name shows.
 *
 * A closed record has no current stage: `end` caps the path with the outcome (Won in emerald, Lost in ruby) and how
 * long it took; `reached` names the stages it passed. Won sweeps emerald along the passed stages, left to right.
 */
type Stage = { value: string; label: string; color: string; days?: number | undefined };
type StagePathProps = {
  stages: Stage[];
  current: string;
  onMove: (value: string) => void;
  end?: { outcome: "won" | "lost"; label: string; detail?: string | undefined } | undefined;
  reached?: string[] | undefined;
  className?: string | undefined;
};

function StagePath({ stages, current, onMove, end, reached, className }: StagePathProps) {
  const at = end ? -1 : stages.findIndex((s) => s.value === current);
  const tint = stages[Math.max(at, 0)]?.color;
  const won = end?.outcome === "won";
  return (
    <div role="group" aria-label="Stage" data-slot="stage-path" className={cn("grid gap-1.5", className)} style={{ gridTemplateColumns: `repeat(${stages.length}, minmax(0, 1fr))${end ? " auto" : ""}` }}>
      {stages.map((s, i) => {
        const state = end ? (reached?.includes(s.value) ? "done" : "next") : i === at ? "now" : i < at ? "done" : "next";
        const c = end ? (won ? "var(--ns-ok)" : s.color) : state === "next" ? undefined : i <= at ? s.color : tint;
        return (
          <button
            key={s.value}
            type="button"
            data-state={state}
            aria-current={state === "now" ? "step" : undefined}
            aria-label={state === "now" ? `${s.label}, current stage` : `Move to ${s.label}`}
            disabled={state === "now"}
            onClick={() => onMove(s.value)}
            style={{ "--c": c } as React.CSSProperties}
            className="group flex min-w-0 cursor-pointer flex-col gap-2 rounded-[4px] text-left outline-hidden focus-visible:outline-2 focus-visible:outline-offset-4 focus-visible:outline-[var(--ns-signal)] disabled:cursor-default"
          >
            <i
              data-ns-glide=""
              style={{ transitionDelay: won ? `${i * 60}ms` : undefined }}
              className={cn(
                "block h-1.5 rounded-[2px] [transition:background-color_400ms_ease,box-shadow_400ms_ease]",
                state === "next" && "bg-[var(--ns-line)]",
                state === "done" && "bg-[color-mix(in_oklab,var(--c)_55%,transparent)]",
                state === "now" && "bg-[var(--c)] shadow-[0_0_0_3px_color-mix(in_oklab,var(--c)_18%,transparent)]",
              )}
            />
            <span
              className={cn(
                "flex min-w-0 items-baseline gap-[7px] overflow-hidden text-[length:var(--ns-text-meta)] text-[var(--ns-ink-3)] group-hover:text-[var(--ns-ink-2)]",
                state === "now" ? "text-[var(--ns-ink)] group-hover:text-[var(--ns-ink)] max-[600px]:overflow-visible" : "max-[600px]:hidden",
                /* on a phone the one name shown may be wider than its stage; late stages let it run back to the left */
                state === "now" && i >= stages.length / 2 && "max-[600px]:justify-end",
              )}
            >
              <span className={cn("min-w-0 truncate", state === "now" && "max-[600px]:shrink-0 max-[600px]:overflow-visible")}>{s.label}</span>
              {/* the days drop first when a stage is narrow (a tablet's path), so the name stays whole */}
              {state !== "next" && s.days !== undefined && <b className={cn("shrink-0 font-[family-name:var(--ns-font-display)] text-[length:var(--ns-text-meta)] font-[number:var(--ns-weight-medium)]", state === "now" ? "text-[color-mix(in_oklab,var(--c)_var(--ns-tint-ink),var(--ns-ink))]" : "text-[var(--ns-ink-3)]")}>{s.days} {s.days === 1 ? "day" : "days"}</b>}
            </span>
          </button>
        );
      })}
      {end && (
        <div data-slot="stage-end" data-outcome={end.outcome} className="flex min-w-16 flex-col gap-2 pl-1" style={{ "--c": won ? "var(--ns-ok)" : "var(--ns-bad)" } as React.CSSProperties}>
          <i data-ns-moves="" className="block h-1.5 origin-left rounded-[2px] bg-[var(--c)] shadow-[0_0_0_3px_color-mix(in_oklab,var(--c)_18%,transparent)] [animation:ns-sweep_520ms_var(--ns-ease)_both]" style={{ animationDelay: won ? `${stages.length * 60}ms` : undefined }} />
          <span className="flex items-baseline gap-[7px] text-[length:var(--ns-text-meta)] whitespace-nowrap text-[var(--ns-ink)]">
            {end.label}
            {end.detail && <b className="font-[family-name:var(--ns-font-display)] font-[number:var(--ns-weight-medium)] text-[color-mix(in_oklab,var(--c)_var(--ns-tint-ink),var(--ns-ink))]">{end.detail}</b>}
          </span>
        </div>
      )}
    </div>
  );
}

export { StagePath, type StagePathProps };
```

The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.