Oros UI

Search documentation

Search Oros UI pages and components.

Badge

Displays a compact label for status, category, or metadata.

DefaultSecondaryOutlineGhostLink

Installation

Install Badge from Oros with shadcn CLI 4.13.0.

pnpm dlx shadcn@4.13.0 add @oros/badge

Usage

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

Open the Source tab in the preview for a complete working example.

Anatomy

ExportResponsibility
BadgeThe root component that owns the primary structure and state.
badgeVariantsReturns the component's class variants for compatible compositions.

API Reference

Badge exports 2 named entries. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.

  • Badge Component
  • badgeVariants Utility

Accessibility

  • Badge adds no application-specific accessible name by itself; use semantic content and label any interactive descendants.
  • Do not communicate state or meaning through color alone, and verify the composed result at text zoom and with keyboard navigation.

Source

Badge uses the standard shadcn API and is distributed through Oros. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.