Badges are read-only indicators used to communicate a category, metadata, a numeric quantity, or a process's current state.
| # | Required | Element | Description |
|---|---|---|---|
| 1 | Container | The colored, rounded shape that holds the Badge content. | |
| 2 | Status indicator | A small colored dot marking an operational or lifecycle state. | |
| 3 | Label | Text describing the category, quantity, or status. |
Badges and Tags are similar components used to visually convey some type of metadata. However, it's important to understand the difference as they are not interchangeable:
Color can be helpful for conveying meaning to users when paired with descriptive text. When using color, be consistent with their usage across the app. Avoid using color purely for decoration to fit a particular color scheme or theme.
Reserve the status indicator dot for Badges that describe an operational or lifecycle state, such as online, running, or syncing. A static category or tier has no state to indicate.
Base Badges are used for categorization, metadata, tiers, or numeric values that don't change with a lifecycle state.
Status Badges include a colored dot to communicate process states within a lifecycle such as success or failure.
Badges are available in a range of colors with the default being grey. Within this range, a specific subset of colors is used semantically across the application.
For more information regarding color and accessibility, see Color and meaning.
Badges have a wide range of colors.
Semantic colors convey a consistent visual meaning throughout the application.
Badge text is bold by default for readability and emphasis. Use a lighter font weight for cases where the Badge should be less visually prominent. Light text is not available on a status Badge.
Bold serves as the default weight.
Lighter weights carry less visual emphasis.
A Badge sizes itself to its content. When a container is too narrow, its text wraps to a second line by default. Enable truncation to keep the Badge on a single line and clip overflowing text with an ellipsis instead, such as in a fixed-width table column. Keep the label short enough to stay understandable when clipped.
When truncation is enabled, the label is clipped to a single line.
Write Badge text in sentence case for consistency across the application.
Limit Badge text to one or two words, or a number, that accurately describes the category or status. Badges exist inline with supporting text so avoid full sentences.