Ballmac UI home

Badge

A small pill label in four variants with an optional status dot and success, warning and error tones. Style links with badgeVariants().

6/6 checksv1.0.0Updated Sep 28, 2026
What changed
Newv2.4.0Pro planOverdueDraftChangelog

Installation

The default, and what a Radix-style project installs.

$ pnpm dlx shadcn@latest add @ballmac/badge

Usage

import { Badge } from "@/components/ballmac/badge"

The full example is in the Code tab above.

Examples

Status

  • api-gatewayDeployed
  • web-dashboardDegraded
  • billing-workerFailed
  • search-indexerQueued

API reference

PropTypeDefault
asChild

Render the child element (for example a link) with badge styles.

booleanfalse
dot

Show a small leading dot. On by default when `status` is set.

boolean—
variant"default" | "secondary" | "outline" | "destructive""default"
status"neutral" | "success" | "warning" | "error"—

Also accepts the standard attributes of its root element.

Quality scorecard

6/6

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    1 tab stop, each showing a visible change when it takes focus.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • For information: Automated tests

    No test file of its own yet.

  • For information: Footprint

    1.2 KB of source (gzip) in 1 file. Installs radix-ui, class-variance-authority.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

Short metadata or status label. Use variant for emphasis, status (neutral | success | warning | error) for state with a coloured dot, and badgeVariants() on an <a> for a link. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Badge (@ballmac/badge) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Status of a deployment, invoice or job
  • Counts, plan names and version tags
  • Small labels on cards and table rows

Not for

  • Clickable filters that toggle (use a toggle or button)
  • Long text (it doesn't wrap)
  • Notifications that need attention (use an alert or toast)

Registry JSON: https://ui.ballmac.com/r/badge.json

Credits

Based on shadcn/ui Badge, adapted by Ballmac. Free to use in personal and commercial projects.

Registry
shadcn/utils

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.