# Plan Card (Lumen Halo): prompt.md (v1.0.0)

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

An agent proposes a plan and waits for you: numbered steps with Approve, Edit and Reject. Edit turns the steps into fields (Enter adds one, Backspace in an empty one removes it), Reject asks what should change, and an async approval holds its button and says if it fails.

## 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/lumen/controls/plan-card.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-button`, `lumen-input`, `lumen-textarea`, `lumen-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: `PlanCard`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) 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 `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { PlanCard, type PlanStep } from "@/components/ui/lumen/controls/plan-card";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `PlanCard` | — | The card: steps (plan-card-step), actions (plan-card-actions) and the decision (plan-card-decision). |

## 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 `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/controls/plan-card.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
- agent plan approval, human in the loop, approve plan, edit plan steps, AI proposed steps, Lumen
- Before an agent acts: show its plan and let a person approve, adjust or refuse it
- Any multi-step proposal a person should sign off

### Not when
- Watching the run itself: use Agent Run
- Approving a single change to a record: use Approval Flow

## Mistakes
- Run the plan as approved (the steps passed to onApprove), not the original
- Keep step ids stable so edits don't remount fields

## Usage

```tsx
"use client";

import { PlanCard, type PlanStep } from "@/components/ui/lumen/controls/plan-card";

const plan: PlanStep[] = [
  { id: "1", text: "List feature flags not read in 90 days" },
  { id: "2", text: "Open one pull request per service removing them" },
  { id: "3", text: "Ask each owner to review" },
];

export function FlagCleanup() {
  return (
    <PlanCard
      title="Clean up stale feature flags"
      description="14 flags across 5 services."
      defaultSteps={plan}
      onApprove={async (steps) => {
        const res = await fetch("/api/agent/run", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify(steps) });
        // Throwing keeps the plan open and shows the message on the card.
        if (!res.ok) throw new Error("The agent didn't start. Try again.");
      }}
      onReject={(reason) => console.log("Revise:", reason)}
    />
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `title / description` | `ReactNode` |  | What the plan is for. |
| `steps / defaultSteps / onStepsChange` | `PlanStep[] ({ id, text })` |  | Controlled or not; onStepsChange gets the edited steps when the person saves. |
| `status / defaultStatus` | `"proposed" \| "approved" \| "rejected"` | `"proposed"` | The decision. Once decided, the actions give way to a one-line record. |
| `onApprove` | `(steps) => void \| Promise<void>` |  | Start the work. A promise holds Approve busy; a throw keeps the plan proposed and shows why. |
| `onReject` | `(reason: string) => void` |  | Refused, with what should change. |
| `editable` | `boolean` | `true` | Offer Edit. |
| `requireReason` | `boolean` | `false` | Rejecting needs a reason. |
| `labels` | `Partial<PlanCardLabels>` |  | Every word on the card, for other languages. |

Full docs: https://beautiful-ui.dev/components/lumen-plan-card

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- 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 / Enter | Approve, Edit or Reject |
| Enter (editing) | Add a step after this one |
| Backspace (empty step) | Remove it and go to the step before |

## Motion inventory

| Interaction | What moves |
|---|---|
| Approve | Button's loading ticker keeps the width while onApprove runs |

## Accessibility contract (preserve when editing)
- A labelled section; steps are an ordered list, and each edit field is named Step n
- Approve shows a busy state while it works; a failure is an alert
- The decision is announced through a status once made

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-plan-card
```

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 lumen 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/lumen-foundation.json.