Badge

Badges highlight the status of a corresponding object

They are commonly used to accompany headings or within tables to communicate status.

Stable
Show details
Stable
Published: November 25, 2024
Updated: February 14, 2025

Anatomy

Anatomy summary lists and describes all the elements that exist within a component (including other components nested within).

Light
  1. Icon (optional): a System Icon used to visually reinforce the information communicated by the label.
  2. Numeric count (optional): a numeric count of associated objects.
  3. Label (optional): a textual label providing the status or metadata about an object.

Variants

Variants contain different versions of the component depending on specific properties, such as state, size, colour, optional iconography, etc.

Badge
Property Values Default
size Variant medium | small | xSmall medium
icon Boolean true | false true
label Boolean true | false true
numeric-count Boolean true | false true
variant Variant neutral | inverseNeutral | info | success | warning | danger neutral
Badge
Badge
size small variant success
Badge
Badge
size xSmall variant info
Badge
Badge
size xSmall variant inverseNeutral
Badge
Badge
size medium variant warning
Badge
Badge
size small variant warning
Badge
Badge
size xSmall variant warning
Badge
Badge
size small variant neutral
Badge
Badge
size small variant danger
Badge
Badge
size xSmall variant danger
Badge
Badge
size medium variant inverseNeutral
Badge
Badge
size small variant inverseNeutral
Badge
Badge
size xSmall variant neutral
Badge
Badge
size medium variant success
Badge
Badge
size xSmall variant success
Badge
Badge
size medium variant danger
Badge
Badge
size medium variant info
Badge
Badge
size small variant info
Badge
Badge
size medium variant neutral

Component dependencies

This component is internally dependent on the following components:


Help and support