import { Plan } from "@elabs-ai/components-ai";npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-aiPrompt for your coding agent
Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.
Add the brand-ui Plan component (from @elabs-ai/components-ai) to this project. 1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`. 2. Look Plan up before writing code: `npx -y @elabs-ai/components-cli docs Plan` prints its real props, variants, what it pairs with and what to avoid. 3. If @elabs-ai/components-ai is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-ai` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui @elabs-ai/components-ai`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`. 4. Use it here: [the screen or file, and what it should show] 5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop. 6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.
Avoid
- Reaching for it in a console transcript — the console counterpart of a three-state agent checklist is TerminalTodoList.
- Rendering a parse/validation error while the plan is still arriving — a half-streamed plan is not a failure (conventions.md, Loading & streaming states).
- Using Plan for a finished run — a settled trace is a Task; Plan is the intent, not the record.
- Hand-rolling the streaming affordance — pass `isStreaming` and let the shipped Shimmer carry it.
- Wrapping a pending decision in an assertive live region — it contains focusable controls, so it is a labelled group; only the settled outcome announces.
- Encoding the decision by rail colour alone — the status line states it in text as well.
Works with
Contains
Pairs with
Examples
Streaming
Awaiting
Approved
Changes Requested
API
Plan
| Prop | Type | Description |
|---|---|---|
isStreaming | boolean | |
status | PlanStatus | The plan's decision status. Omit it to keep today's display-only behaviour. When both `status` and `isStreaming` are given, `status` wins (a `status="approved"` plan never shimmers, even if `isStreaming` is still `true`). |
PlanAction
PlanApprove
PlanComment
PlanContent
PlanDescription
| Prop | Type | Description |
|---|---|---|
childrenrequired | string |
PlanFooter
PlanHeader
PlanRequestChanges
PlanStatusLine
| Prop | Type | Description |
|---|---|---|
children | ReactNode |
PlanTitle
| Prop | Type | Description |
|---|---|---|
childrenrequired | string |
PlanTrigger
Theming
The tokens each state resolves to. Change the token and every theme follows.
| State | Token |
|---|---|
| approved | border-s-4 border-s-success rail on the card |
| changes-requested | border-s-4 border-s-warning rail on the card |
| awaiting | border-s-4 border-s-border-strong rail on the card |