Badge
A Badge component is used to display small pieces of information or status indicators.
Import
tsimport { Badge } from "@kobalte/core/badge";// orimport { Root } from "@kobalte/core/badge";
tsimport { Badge } from "@kobalte/core/badge";// orimport { Root } from "@kobalte/core/badge";
Features
- Auto-populated ARIA labeling via the textValue prop for enhanced accessibility.
- Built-in ARIA support with role="status" to communicate dynamic updates.
Anatomy
The badge consists of:
- Badge: The root container for the badge that supports accessibility and content customization.
tsx<Badge />
tsx<Badge />
Example
5 messages
API Reference
Badge
Badge is equivalent to the Root import from @kobalte/core/badge.
| Prop | Description |
|---|---|
| textValue | string | undefined Accessible text description of the badge if child is not text |
Rendered elements
| Component | Default rendered element |
|---|---|
Badge | span |