For AI agents: the documentation index is at /llms.txt, and any docs page is available as Markdown by appending .md to its URL.

Badge

Verified

A short status or count label.

PaidDraftScheduledOverdue

When to use

Use when: A short status, count, or category next to other content.
Avoid when: The text is an action; use Button. Or it needs a sentence; use Alert.

Installation

bunx shelf add badge

The source lands in src/components/ui/badge.tsx, along with any Shelf items it builds on, and .shelf/lock.json records what was installed. It's yours to edit.

Usage

import { Badge } from "@/components/ui/badge";

<Badge />

Built on

Packages: @stylexjs/stylex
Shelf items: foundations, utils
Figma: Optional native Figma library. See Designers.

Verified

Size: 1.0 kB gzipped on its own, 2.8 kB with the Shelf items and packages it builds on. JS and CSS in a production build, without React.
Accessibility: Axe passes on 2 stories
Behavior: 2 interaction tests in Storybook
React Compiler: Compiles with React Compiler
React Doctor: React Doctor finds nothing