Skip to main content

Button

Coreaction

Primary action trigger — the canonical way to invoke an action.

import { Button } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt 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 Button 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 Button up before writing code: `npx -y @elabs-ai/components-cli docs Button` 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

  • Two primary Buttons in the same action group — demote one to secondary/outline.
  • Button used for navigation — use a link instead (asChild + <a>, or the variant="link").
  • destructive variant for an irreversible action with no confirm step — wrap in AlertDialog.
  • Icon-only Button without an aria-label — the control has no accessible name.

Works with

Pairs with

Avoid next to

  • another primary Button

Examples

8 live examples

Secondary

Destructive

Outline

Outline Subtle

Ghost

All Variants

Keyboard focus (WCAG 1.4.11)

#67 — the RENDERED lock on the compound focus indicator (ADR 0027 Amendment). A class-string assertion would be worthless here: `focus-ring` could name a single-layer ring and the class would still be present while the ratio stayed at 1.36:1, which is the exact failure this story exists to prevent. So this play function measures the SHIPPED pixels — it reads the computed indicator layers off a really-focused button, resolves the ground the indicator is actually drawn on by walking up to the first non-transparent ancestor, and asserts at least one layer clears WCAG 1.4.11 (3:1) against it. It is theme-agnostic on purpose: whichever theme the run resolves (the toolbar global, or `STORYBOOK_THEME=<slug>` headless — see @.claude/rules/storybook-mcp.md § Themes) the SAME assertion has to hold, so one story covers `light`, `dark` and any consumer theme a fork adds.

API

Button

variant
default (default)secondarydestructiveoutlineoutline-subtleghostlink
size
smdefault (default)lgiconicon-smicon-lg
PropTypeDescription
asChildbooleanRender the child element as the button (Radix Slot) instead of a <button>.

Also accepts: ButtonHTMLAttributes<HTMLButtonElement>, VariantProps<typeof buttonVariants>

Theming

The tokens each state resolves to. Change the token and every theme follows.

StateToken
hoverbg-primary-hover (variant default; active: bg-primary-active)
focusfocus-ring — the compound indicator: a ring-2 in --ring plus a 1px --ring-contour outline (#67) + ring-offset-2 ring-offset-background
disabledopacity-50 pointer-events-none