Icon Button

44px icon-only action; an accessible label is required.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• Category: Actions & controls
• Status: stable public Registry/export-map component family
• Targets: iOS · Android · Web, subject to the compatibility contract
• Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
• Source: packages/ui/src/components/icon-button.tsx

Import

import { IconButton } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add icon-button

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

• Primary export: IconButton
  • Also routed here, outside the Registry family:
    • icon-button
  • Package export subpath: @beemvp/beeui-ui/icon-button

Exported types: IconButtonProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Stateless icon-only pressable sharing Button’s disabled/loading semantics; an accessible label (accessibilityLabel) is required because there is no visible text to derive one from. Button’s own size variant ('sm'/'md'/'lg'/'icon', defaulting to 'icon') renders a square control at Button’s matching control-height token here instead of Button’s rectangular label padding. count renders a small overlay badge anchored to the top-end corner (e.g. an unread count) and is appended to accessibilityLabel so it is announced; omit it for no badge.

Props

IconButtonProps

Prop	Type	Default	Description
accessibilityLabel (required)	string	—	Required (unlike Button’s optional label): an icon-only button has no text content to infer an accessible name from.
children (required)	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
count	React.ReactNode	—	A small overlay badge anchored to the top-end corner (e.g. an unread count on a notification bell). A number/string renders inside a pill and is appended to accessibilityLabel so the count is announced; any other node renders as-is and must carry its own accessible text if it needs to be announced. Omit for no badge (the default).
countClassName	string	—	Applied to the count badge’s own container; has no effect when count is omitted.

Also carries every prop of Omit<ButtonProps, 'accessibilityLabel' | 'children' | 'labelClassName'> — documented on the Button page, not reproduced here.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

• No additional provider is required by this family. BeeUIProvider remains the recommended application root.
• Peer/native dependencies visible to this Registry item: react, react-native
• Registry dependency closure: button, core-cn, theme
• Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
• Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, but its source branches on Platform, so some behavior differs by target.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

• Roles this family assigns: none set in icon-button.tsx.
• Accessibility states and properties it sets: accessibilityLabel, hidden — read from icon-button.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

• Style axes: size (4 values, inherited from ButtonProps), variant (5 values, inherited from ButtonProps).
• Class-name surfaces: className, countClassName.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

• Primary executable fixture: apps/showcase/__tests__/icon-button-size-and-count.test.tsx
• Additional fixture: apps/showcase/__tests__/toolbar-arrow-key-roving-focus.test.tsx
• Additional fixture: apps/showcase/__tests__/toolbar-item-visible-mode-contract.test.tsx
• Additional fixture: apps/showcase/__tests__/toolbar-non-focusable-children-roving-focus.test.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

• basic — smallest meaningful complete usage

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

• Family root / primary export: IconButton
  • Exported type surface:
    • IconButtonProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Icon Button is actually used: 15 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { Box, Button, IconButton, Section } from '@beemvp/beeui-ui';

lines 530–544:

              <Section
                action={<IconButton accessibilityLabel="Add item" variant="outline">＋</IconButton>}
                description="Variants, disabled state, and loading behavior."
                title="Actions"
              >
                <Box className="gap-3">
                  <Button>Primary action</Button>
                  <Button variant="secondary">Secondary action</Button>
                  <Button variant="outline">Outline action</Button>
                  <Button variant="ghost">Ghost action</Button>
                  <Button variant="destructive">Destructive action</Button>
                  <Button disabled>Disabled action</Button>
                  <Button loading>Loading action</Button>
                </Box>
              </Section>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

Any string child is styled by Button’s own label rules with no override hook. count accepts any node, but only a string/number value renders inside the badge pill and is appended to the accessible name — any other node renders as-is and must carry its own accessible text.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source