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

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

What a step usually needs before it moves on, ticking itself as each thing comes true, and saying "Ready to move on" at the end. A soft gate: it informs and never blocks..

## 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/blocks/stage-checklist.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: `StageChecklist`, 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-ease`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-line`, `--ns-line-soft`, `--ns-ok`, `--ns-ok-ink`, `--ns-panel`, `--ns-radius-lg`, `--ns-text-body`, `--ns-text-meta`, `--ns-text-small`, `--ns-time-color`, `--ns-time-dialog`, `--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 { StageChecklist } from "@/components/ui/notchset/blocks/stage-checklist";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/blocks/stage-checklist.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 { StageChecklist } from "@/components/ui/notchset/blocks/stage-checklist";
import { Button } from "@/components/ui/notchset/button";

export default function StageChecklistDemo() {
  const [done, setDone] = React.useState<string[]>(["quote"]);
  const [round, setRound] = React.useState(0);
  /* the remaining conditions come true one by one, as they would in the app */
  /* one replay at a time: a new one cancels the last one's timers, and leaving cancels them all */
  const timers = React.useRef<ReturnType<typeof setTimeout>[]>([]);
  const clear = () => {
    timers.current.forEach(clearTimeout);
    timers.current = [];
  };
  React.useEffect(() => clear, []);
  const play = () => {
    clear();
    setDone(["quote"]);
    setRound((n) => n + 1);
    timers.current.push(setTimeout(() => setDone(["quote", "buyer"]), 600), setTimeout(() => setDone(["quote", "buyer", "date"]), 1300));
  };
  return (
    <div className="flex w-full max-w-[420px] flex-col gap-3">
      <StageChecklist
        key={round}
        title="Proposal usually needs"
        items={[
          { id: "quote", label: "Pricing sent", done: done.includes("quote") },
          { id: "buyer", label: "The economic buyer has seen it", done: done.includes("buyer"), hint: "Forward the quote to Ines Duarte" },
          { id: "date", label: "A decision date agreed", done: done.includes("date"), hint: "Ask on Thursday's call" },
        ]}
        action={
          <Button size="sm" variant="primary">
            Move to Security review
          </Button>
        }
      />
      <Button size="sm" className="self-start" onClick={play}>
        Play it
      </Button>
    </div>
  );
}
```

This example also uses `button` (https://notchset.dev/components/button). Installing this item doesn't bring them; to paste the example as it is: `npx shadcn@latest add https://notchset.dev/r/stage-checklist.json https://notchset.dev/r/button.json`.

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `title` | `string` |  | Required. |
| `items` | `ChecklistItem[]` |  | Required. |
| `doneLabel` | `string` | `"Ready to move on"` | what the header says once everything is done |
| `action` | `React.ReactNode` |  | an optional next step, shown once everything is done |

Full docs: https://notchset.dev/blocks/stage-checklist

## 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-checklist.json
```

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

## Source

### components/ui/notchset/blocks/stage-checklist.tsx

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

/*
 * Stage checklist: what a step usually needs before it moves on, ticking itself as each thing comes true (the
 * quote goes out, the buyer is in the thread). A tick draws itself the moment its condition turns true, and when
 * the last one lands the header says so: "Ready to move on". It is a soft gate: it informs, it never blocks; the
 * host decides what, if anything, happens next. Items that start done are simply done, with no replayed draw.
 *
 *   <StageChecklist title="Proposal usually needs" items={[
 *     { id: "quote", label: "Quote sent", done: quoteSent },
 *     { id: "buyer", label: "Economic buyer has seen it", done: buyerSeen, hint: "Forward the quote to Ines" },
 *   ]} />
 */
type ChecklistItem = { id: string; label: string; done: boolean; hint?: string | undefined };
type StageChecklistProps = {
  title: string;
  items: ChecklistItem[];
  /** what the header says once everything is done */
  doneLabel?: string | undefined;
  /** an optional next step, shown once everything is done */
  action?: React.ReactNode;
  className?: string | undefined;
};

/** A tick in a ring; it draws itself only when it turns true after mount. */
function Tick({ done, fresh }: { done: boolean; fresh: boolean }) {
  return (
    <span
      aria-hidden
      className={cn(
        "grid size-[18px] shrink-0 place-items-center rounded-full [transition:background-color_var(--ns-time-color),box-shadow_var(--ns-time-color)]",
        done ? "bg-[var(--ns-ok)] text-white" : "shadow-[inset_0_0_0_1.5px_var(--ns-line)]",
      )}
    >
      {done && (
        <svg viewBox="0 0 12 12" className="size-2.5" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
          <path d="M2.5 6.2 5 8.6l4.6-5.1" pathLength={1} strokeDasharray="1" data-ns-still="" className={cn(fresh && "[animation:ns-tick-draw_var(--ns-time-dialog)_var(--ns-ease)_both]")} />
        </svg>
      )}
    </span>
  );
}

function StageChecklist({ title, items, doneLabel = "Ready to move on", action, className }: StageChecklistProps) {
  const done = items.filter((i) => i.done).length;
  const all = items.length > 0 && done === items.length;
  /* remember what was already true at mount, so only a change draws */
  const [seen] = React.useState(() => new Set(items.filter((i) => i.done).map((i) => i.id)));
  const titleId = React.useId();
  return (
    <section data-slot="stage-checklist" data-complete={all || undefined} aria-labelledby={titleId} className={cn("flex flex-col gap-2.5 rounded-[var(--ns-radius-lg)] bg-[var(--ns-panel)] px-4 py-3.5 shadow-[inset_0_0_0_1px_var(--ns-line-soft)]", className)}>
      <header className="flex items-baseline gap-2">
        <h3 id={titleId} className={cn("m-0 text-[length:var(--ns-text-body)] font-[number:var(--ns-weight-medium)] [transition:color_var(--ns-time-color)]", all ? "text-[var(--ns-ok-ink)]" : "text-[var(--ns-ink)]")}>
          {all ? doneLabel : title}
        </h3>
        <span role="status" aria-live="polite" className="ml-auto text-[length:var(--ns-text-small)] text-[var(--ns-ink-3)] tabular-nums">
          {done} of {items.length}
        </span>
      </header>
      {/* progress as a hairline, so the whole reads at a glance */}
      <span aria-hidden className="block h-[3px] overflow-hidden rounded-full bg-[var(--ns-line-soft)]">
        <i data-ns-glide="" style={{ width: `${items.length ? (done / items.length) * 100 : 0}%` }} className={cn("block h-full rounded-full [transition:width_var(--ns-time-dialog)_var(--ns-ease),background-color_var(--ns-time-color)]", all ? "bg-[var(--ns-ok)]" : "bg-[var(--ns-ink-2)]")} />
      </span>
      <ul className="m-0 flex list-none flex-col gap-1.5 p-0">
        {items.map((i) => (
          <li key={i.id} className="flex items-start gap-2.5">
            <span className="pt-px">
              <Tick done={i.done} fresh={i.done && !seen.has(i.id)} />
            </span>
            <span className="flex min-w-0 flex-col">
              <span className={cn("text-[length:var(--ns-text-small)] [transition:color_var(--ns-time-color)]", i.done ? "text-[var(--ns-ink-2)]" : "text-[var(--ns-ink)]")}>
                {i.label}
                <span className="sr-only">{i.done ? ", done" : ", not yet"}</span>
              </span>
              {!i.done && i.hint && <span className="text-[length:var(--ns-text-meta)] text-[var(--ns-ink-3)]">{i.hint}</span>}
            </span>
          </li>
        ))}
      </ul>
      {all && action && <div className="flex pt-0.5">{action}</div>}
    </section>
  );
}

export { StageChecklist, type ChecklistItem, type StageChecklistProps };
```

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.
