Skip to main content

IconButton

Core

A single affordance for an icon-only control: label becomes both the aria-label and the tooltip text, so they cannot diverge.

import { IconButton } 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 IconButton 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 IconButton up before writing code: `npx -y @elabs-ai/components-cli docs IconButton` 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.

Examples

4 live examples

Disabled

Disabled (with reason)

A disabled control that still explains WHY via the tooltip + `aria-describedby`.

Sizes

API

IconButton

PropTypeDescription
labelrequiredstringAccessible name AND tooltip text — a single source of truth, so the two can never drift out of sync (the failure this component exists to close: `aria-label` and a tooltip's children set independently, most call sites only setting one).
iconrequiredReactNodeThe glyph (typically a `lucide-react` element).
sizeIconButtonSizeIcon-only size axis. Default `"icon"`.
disabledReasonstringShown appended to the tooltip text, and — independently — exposed via `aria-describedby` through an `sr-only` node that is present whenever this prop is (i.e. it does NOT depend on the tooltip being open, and it is not rendered at all when there is no reason — so it can never be read as stray text), so assistive tech gets the reason even while the button is disabled (a disabled `<button>` still exposes its ARIA attributes; it just isn't focusable/hoverable itself, which is why the tooltip trigger wraps a focusable `<span>` instead — see the render below).
sideComponentProps<typeof TooltipContent>["side"]Tooltip placement. Default `"top"`.

Also accepts: Omit< ButtonHTMLAttributes<HTMLButtonElement>, "title" | "children" | "aria-label" | "aria-describedby" >, Pick<VariantProps<typeof buttonVariants>, "variant">