Components
Badge
Inline labels for status, versions, and metadata.
Use Badge inside text or as a standalone status label.
Basic usage#
BadgeColors#
Gray Blue Green Yellow Orange Red Purple White Surface White destructive Surface destructiveSizes#
Extra small Small Medium LargeShapes#
Rounded PillIcons#
Named icons use the Lucide icon registry. You can also pass an image URL, a local image path, or a rendered React node.
Verified Pending BlockedStroke and disabled states#
Stroke DisabledCombined properties#
Premium Verified BetaProperties#
| Name | Type | Description |
|---|---|---|
| color | 'gray' | 'blue' | 'green' | 'yellow' | 'orange' | 'red' | 'purple' | 'white' | 'surface' | 'white-destructive' | 'surface-destructive' | Color treatment. Default: gray |
| size | 'xs' | 'sm' | 'md' | 'lg' | Badge size. Default: md |
| shape | 'rounded' | 'pill' | Corner shape. Default: rounded |
| icon | string | ReactNode | Lucide icon name, image source, or rendered icon. |
| stroke | boolean | Uses an outline instead of a filled background. Default: false |
| disabled | boolean | Reduces emphasis and exposes the disabled state to assistive technology. Default: false |
| className | string | Additional classes applied to the badge. |
| children | ReactNode | Badge label. |
Last updated on