Badge

Compact semantic status label with paired foreground/background tokens.

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: Data display
• 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/badge.tsx

Import

import { Badge, badgeLabelVariants, badgeVariants } from '@beemvp/beeui-ui';

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

pnpm beeui add badge

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

• Family exports: Badge badgeLabelVariants badgeVariants
  • Also routed here, outside the Registry family:
    • badge
  • Package export subpath: @beemvp/beeui-ui/badge

Exported types: BadgeProps

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 semantic status label; variant selects the paired foreground/background token pair, with no controlled/open state or callbacks.

Props

BadgeProps

Prop	Type	Default	Description
children	React.ReactNode	—	Content rendered inside this element. The family’s composition section states which children it expects.
className	string	—	Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
labelClassName	string	—	Extra utility classes for the label text specifically, merged after the component’s own.
variant	'primary' | 'secondary' | 'success' | 'warning' | 'destructive' | 'info' | 'outline'	'primary'	Chooses this element’s variant from badgeVariants’s presets, declared in packages/ui/src/components/badge.tsx — the classes each value applies are there.

Also carries every prop of Omit<ViewProps, 'children'> — that upstream contract is 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: core-cn, text, 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, and its own source takes no Platform branch.

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 badge.tsx.
• Accessibility states and properties it sets: none set in badge.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: variant (7 values) — the values are in the props tables above.
• Class-name surfaces: className, labelClassName.

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__/badge-outline-contrast.test.tsx
• Additional fixture: apps/showcase/__tests__/perf-render-commit.test.tsx
• Additional fixture: apps/showcase/__tests__/table-cell-alignment-and-content-hug.test.tsx
• Additional fixture: apps/showcase/component-gallery/component-gallery.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
• variants — the variants example

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: Badge
  • Public composition parts / helpers:
    • badgeLabelVariants
    • badgeVariants
  • Exported type surface:
    • BadgeProps

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 Badge is actually used: 43 lines in 2 places. 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 { Badge, Box, DescriptionItem, DescriptionList, ListItem, Section, Separator, SettingsItem, Switch } from '@beemvp/beeui-ui';
import * as React from 'react';
import { Uniwind, useUniwind } from 'uniwind';

lines 549–556:

              <Box className="flex-row flex-wrap gap-2">
                <Badge>Primary</Badge>
                <Badge variant="secondary">Secondary</Badge>
                <Badge variant="success">Success</Badge>
                <Badge variant="warning">Warning</Badge>
                <Badge variant="destructive">Error</Badge>
                <Badge variant="info">Info</Badge>
              </Box>

Fixture state this block reads (same file, lines 458, 461):

  const { theme } = useUniwind();
  const [notifications, setNotifications] = React.useState(true);

lines 1047–1081:

              <Section description="Read-only application information patterns." title="Metadata and rows">
                <DescriptionList>
                  <DescriptionItem label="Runtime" value="React Native 0.86.2" />
                  <DescriptionItem label="Styling" value="Uniwind 1.10.1" />
                  <DescriptionItem
                    description="Generated and compiled in CI"
                    label="Native verification"
                    value="Expo + bare RN"
                  />
                </DescriptionList>
                <Separator />
                <ListItem
                  description="Open your profile"
                  onPress={() => undefined}
                  title="Profile"
                  trailing={<Badge variant="success">Active</Badge>}
                />
                <SettingsItem
                  description="Changes app appearance"
                  onPress={() => undefined}
                  title="Appearance"
                  value={theme}
                />
                <SettingsItem
                  description="Native preference control"
                  title="Push notifications"
                  trailing={
                    <Switch
                      accessibilityLabel="Push notifications"
                      onValueChange={setNotifications}
                      value={notifications}
                    />
                  }
                />
              </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

Only plain string or number children receive the badge’s own label typography and labelClassName; an element child is rendered untouched, so an icon or custom node inside a badge carries none of the variant’s paired foreground color.

Related

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