import { StatusBadge } from "@elabs-ai/components-ui";npm install @elabs-ai/components-tokens @elabs-ai/components-uiPaste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.
Add the brand-ui StatusBadge component (from @elabs-ai/components-ui) 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 StatusBadge up before writing code: `npx -y @elabs-ai/components-cli docs StatusBadge` prints its real props, variants, what it pairs with and what to avoid. 3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). 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
- Using it for a neutral label or a count — that is Badge; this one asserts an execution state.
- Inventing an eighth status by passing a custom label into the canonical enum — map an out-of-vocabulary state ONCE, near your domain, through the {label, tone, icon} form.
- Relying on the tone alone to distinguish two states — the glyph is the second channel that keeps them apart in greyscale.
Works with
Pairs with
Avoid next to
Examples
All Statuses
The canonical 7-state vocabulary. Calm states (pending, running, complete, denied, skipped) use the quiet wash/neutral treatment; only the two attention states (awaiting-approval, failed) get the solid fill.
Sizes
Custom Labels
`children` override the default label; counts are a typical use.
Custom Vocabulary
The bounded out-of-vocabulary escape hatch (#363): a run engine whose real states the 7 canonical values don't cover (`aborted`, `stopped_guardrail`, a distinct "not run" dash state) maps them to `{label, tone, icon?}` — CALM treatments only, so the calm/loud contrast against the canonical set below stays meaningful (only `awaiting-approval`/`failed` ever get a solid fill).
Appearances
The four explicit `appearance` overrides on every colour-bearing status — each renders a `data-appearance` attribute regardless of the ancestor `--badge-appearance` token. `pending`/`denied`/`skipped` are already neutral pills, so `appearance` has no additional effect there.
Token Driven Appearance
With no explicit `appearance` prop, an ancestor's `--badge-appearance` token drives the treatment — including the out-of-vocabulary `tone` hatch, which never reaches `solid` even here (the calm-only integrity constraint), so its custom statuses stay on their tint wash.
Icons
The `StatusIcon` atom for tight rows (test results, rail nodes) — the adjacent row text must carry the status name for AT users.
API
StatusBadge
| Prop | Type | Description |
|---|---|---|
statusrequired | Status | CustomStatus | The canonical execution status, or a mapped out-of-vocabulary one (#363). |
hideIcon | boolean | Render label-only (no status icon). |
appearance | BadgeAppearance | Explicit per-instance override of the fill/border/ink treatment — see `Badge`'s own doc. Meaningful only on the colour-bearing statuses (`running`/`complete`/`awaiting-approval`/`failed`) and tones (`info`/`success`/`warning`/`destructive`); `pending`/`denied`/`skipped` and the `neutral` tone are already neutral pills. On a `CustomStatus` (the out-of-vocabulary hatch), `"solid"` is never honoured — the hatch is calm-only (integrity constraint 2, file docblock). |