Skip to Content

Badge

An inline component that visually displays status, labels, categories, and similar. Use it next to text to convey supplementary information or to indicate the state of list items.

Preview

PrimarySuccessWarningDanger

Examples

Variant

Controls the visual emphasis level of the badge.

ValueDefaultDescription
solidFilled background. Use for states that need the most emphasis.
outlineBorder only. Use for states with medium emphasis.
subtleLight background. Use for supplementary information with low emphasis.
weakLightest background. Use for tags with low contrast against the background.
SolidOutlineSubtleWeak

Intent

Controls the semantic color of the badge.

ValueDefaultDescription
primaryPrimary categories and core information.
secondarySecondary categories and supplementary information.
successCompletion, normal, or active state.
warningCaution or incomplete state.
dangerError, inactive, or danger state.
neutralNeutral state.
PrimarySecondarySuccessWarningDangerNeutral

Size

Controls the badge size. Choose based on the size of adjacent text or components.

ValueDefaultDescription
smallFor secondary labels next to body text.
mediumMost versatile size.
largeFor use with larger components.
xlargeWhen heading-level size is needed.
SmallMediumLargeXLarge

Rounded

Controls the corner radius of the badge.

ValueDefaultDescription
smallSmall corner radius
mediumDefault corner radius
largeLarge corner radius (pill-like)

Show dot

Shows a status dot before the badge. Use when indicating real-time state changes or notifications.

  • Type: boolean
  • Default: false
ActiveErrorPending

Guidelines

Choosing variant

  • solid: Use when information needs clear emphasis. Suitable for list status indicators, count badges near CTAs, and similar.
  • outline / subtle / weak: Use for lightweight tags or category labels next to text. Avoid over-emphasizing on the screen.

Using the dot

Use showDot to indicate real-time status. Recommended patterns: success ↔ online/normal, danger ↔ error/offline, warning ↔ caution.

Props

Props

Prop
Default
Type
size?
"medium"
"small" | "medium" | "large" | "xlarge"
variant?
"solid"
"solid" | "outline" | "subtle" | "weak"
intent?
"primary"
"primary" | "secondary" | "success" | "warning" | "danger" | "neutral"
rounded?
"medium"
"small" | "medium" | "large"
showDot?
false
boolean
children
ReactNode
Last updated on