Components

Badge

Inline labels for status, versions, and metadata.

Use Badge inside text or as a standalone status label.

Basic usage#

Badge

Colors#

Gray Blue Green Yellow Orange Red Purple White Surface White destructive Surface destructive

Sizes#

Extra small Small Medium Large

Shapes#

Rounded Pill

Icons#

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 Blocked

Stroke and disabled states#

Stroke Disabled

Combined properties#

Premium Verified Beta

Properties#

NameTypeDescription
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
iconstring | ReactNode

Lucide icon name, image source, or rendered icon.

strokeboolean

Uses an outline instead of a filled background.

Default: false
disabledboolean

Reduces emphasis and exposes the disabled state to assistive technology.

Default: false
classNamestring

Additional classes applied to the badge.

childrenReactNode

Badge label.

Last updated on