# Run Button (Notchset): prompt.md (v1.0.0)

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

One key that becomes its own stop control: ink with a play glyph and its shortcut, then signal with an elapsed-time readout and a blinking node while the agent runs, a signal outline when stopped, a traced check when complete. A step track and a flipping status line sit under it.

## 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/run-button.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: `RunButton`, 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 { RunButton } from "@/components/ui/notchset/run-button";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `RunButton` | `run-button` | The key, its legend, the step track and the status line. |
| `Key` | `run-button-key` | The button itself. |
| `Track` | `run-button-track` | The step nodes and their trace. |

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/run-button.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
- run agent, stop run, start stop button, run button, agent run control, elapsed time, step progress, Notchset
- Starting and stopping an agent or job from one place
- Showing which step a run is on without a separate progress bar

### Not when
- A one-shot action that finishes instantly: use Button
- Long background jobs the user leaves: use a status row or Progress

## Mistakes
- Pass `step` from your run's events; uncontrolled it stays on the first step
- Bind the shortcut yourself: `kbd` is only the hint

## Usage

```tsx
"use client";

import * as React from "react";
import { RunButton } from "@/components/ui/notchset/run-button";

const STEPS = ["plan", "search_docs", "read_file", "run_sql", "draft", "verify"];

/** onRun returns a promise: the key shows running until it settles, and the abort signal stops it. */
export function RunPlanner({ runAgent }: { runAgent: (signal: AbortSignal, onStep: (i: number) => void) => Promise<void> }) {
  const [step, setStep] = React.useState(0);
  return <RunButton legend="F4 · RUN" name="PLANNER" steps={STEPS} step={step} onRun={(signal) => runAgent(signal, setStep)} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `onRun` | `(signal: AbortSignal) => unknown` |  | Starts the run. Return a Promise and the button tracks it; Stop aborts the signal. |
| `onStop` | `() => void` |  | Called when the user stops the run. |
| `state` | `"idle" \| "running" \| "stopped" \| "complete"` |  | Controlled state. Uncontrolled, Stopped and Complete hold 2.8s, then return to idle. |
| `steps` | `string[]` |  | The run's steps, drawn as nodes under the key. |
| `step` | `number` |  | The current step index. |
| `elapsedMs` | `number` |  | Elapsed time while running; counted by the button when omitted. |
| `kbd` | `string` |  | The shortcut shown while idle (display only). Default "R". |
| `legend / name` | `string` |  | The legend above the key; the first word of the idle status. |
| `status` | `string` |  | Overrides the status line. |
| `labels` | `Partial<RunButtonLabels>` |  | Every word, for other languages. |

Full docs: https://beautiful-ui.dev/components/run-button

## 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 |
|---|---|
| Enter / Space | Run, or stop a running run |

## Performance

- The elapsed readout ticks on one interval only while running; idle and stopped do no work.
- Step changes swap text through the glyph flip, throttled to one frame at a time.

## Responsive

- The key keeps its width while the label changes, so the row never reflows.
- Touch screens get a 44px key.

## Motion inventory

| Interaction | What moves |
|---|---|
| Press | The key drops 1px in 40ms and springs back in 200ms cubic-bezier(.34,1.5,.5,1) |
| Running | The node blinks (r 3.25 ↔ 1.1 every 420ms); the readout ticks every 100ms; the trace fills the step track |
| Complete | The check traces in over 260ms; the step nodes pulse in order, 70ms apart |
| Labels | Glyph flip: characters cycle and land left to right, 14ms apart. Off under reduced motion |

## Accessibility contract (preserve when editing)
- A native button with aria-pressed while running; its name switches between Run and Stop run
- The status line is a polite live region; flipping glyphs are hidden from screen readers, which hear the final text
- State reads from shape as well as colour: play, a filled stop square, an outline when stopped, a check when complete

## Install

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

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.