CMS Design System

Badges hold small amounts of information and draw attention to new or important content.

`<Badge>`

Code snippet

<div>
  <span class="ds-c-badge">1</span>
  <span class="ds-c-badge">Badge</span>
  <span class="ds-c-badge ds-c-badge--big">Badge with size 'big'</span>
</div>

Props

React Properties Documentation
Name	Type	Description
`className`	`string`	Additional classes to be added to the root badge element. Useful for adding utility classes.
`children`required	`string \| React.ReactNode`	Label text or HTML.
`size`	`literal`	Sets the font size of the Badge. Only supports 'big'
`variation`	`'info' \| 'success' \| 'warn' \| 'alert'`	A string corresponding to the badge-component variation classes

Guidance

When to use

To draw attention to new, important content on a page that might otherwise be missed.
To filter results with one or more tags.
To indicate the number of new or unread items within a container. For example, to indicate the number of unread messages within a person’s inbox.

When to consider alternatives

When users are likely to confuse a badge with a button. For example, when the badge appears in the same area of the page as buttons.
To call attention to new or updated content, consider changing the background color of the object itself or experiment with changing the font weight.
When users already expect content to be updated frequently. For example, on a site dedicated to breaking news. In this case placing the new content at the top may be enough.

Usage

Don’t overdo it — if everything on a page is called out as important, nothing is important.
Users may confuse badges as buttons. Always conduct usability testing to make sure your particular implementation is not causing frustration.
Don’t mix interactive and static badges on your site. Once you establish a pattern for how badges behave, users will expect that behavior every time.

Accessibility

When badges are used to call out new content that is dynamically loaded onto a page, be sure to use ARIA live regions to alert screen readers of the change.

Customization

The following Sass variables can be overridden to customize Badge components:

Variable	Default Core Theme Value
`$badge__background-color`	`$color-gray`
`$badge__background-color--alert`	`$color-error`
`$badge__background-color--info`	`$color-primary`
`$badge__background-color--success`	`$color-green`
`$badge__background-color--warn`	`$color-gold`
`$badge__font-color`	`$color-white`
`$badge__font-color--warn`	`$color-base`

Future research

Further usability testing should be done to ensure badges aren't being confused with buttons. Further iteration can be done with sizing and colors if there is confusion.