Documentation and examples for badges, our small count and labeling component.
Example
Badges scale to match the size of the immediate parent element by using relative font sizing and em units.
Example heading
New
Example heading
New
Example heading
New
Example heading
New
Example heading
New
Example heading
New
<div class="h1">Example heading
<span class="badge badge-secondary">New</span>
</div>
<div class="h2">Example heading
<span class="badge badge-secondary">New</span>
</div>
<div class="h3">Example heading
<span class="badge badge-secondary">New</span>
</div>
<div class="h4">Example heading
<span class="badge badge-secondary">New</span>
</div>
<div class="h5">Example heading
<span class="badge badge-secondary">New</span>
</div>
<div class="h6">Example heading
<span class="badge badge-secondary">New</span>
</div>
Badges can be used as part of links or buttons to provide a counter.
<button type="button" class="btn btn-primary">
Notifications
<span class="badge badge-light">4</span>
</button>
Note that depending on how they are used, badges may be confusing for users of screen readers and similar assistive technologies.
While the styling of badges provides a visual cue as to their purpose, these users will simply be presented with the
content of the badge. Depending on the specific situation, these badges may seem like random additional words or numbers
at the end of a sentence, link, or button.
Unless the context is clear (as with the “Notifications” example, where it is understood that the “4” is the number of notifications),
consider including additional context with a visually hidden piece of additional text.
<button type="button" class="btn btn-primary">
Profile
<span class="badge badge-light">9</span>
<span class="sr-only">unread messages</span>
</button>
Contextual variations
Add any of the below mentioned modifier classes to change the appearance of a badge.
Primary
Secondary
Success
Danger
Warning
Info
Light
Dark
<span class="badge badge-primary">Primary</span>
<span class="badge badge-secondary">Secondary</span>
<span class="badge badge-success">Success</span>
<span class="badge badge-danger">Danger</span>
<span class="badge badge-warning">Warning</span>
<span class="badge badge-info">Info</span>
<span class="badge badge-light">Light</span>
<span class="badge badge-dark">Dark</span>
Conveying meaning to assistive technologies
Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies
– such as screen readers. Ensure that information denoted by the color is either obvious from the content itself
(e.g. the visible text), or is included through alternative means, such as additional text hidden with the
.sr-only class.
Pill badges
Use the
.badge-pill modifier class to make badges more rounded (with a larger
border-radius and additional horizontal
padding). Useful if you miss the badges from v3.
Primary
Secondary
Success
Danger
Warning
Info
Light
Dark
<span class="badge badge-pill badge-primary">Primary</span>
<span class="badge badge-pill badge-secondary">Secondary</span>
<span class="badge badge-pill badge-success">Success</span>
<span class="badge badge-pill badge-danger">Danger</span>
<span class="badge badge-pill badge-warning">Warning</span>
<span class="badge badge-pill badge-info">Info</span>
<span class="badge badge-pill badge-light">Light</span>
<span class="badge badge-pill badge-dark">Dark</span>
Links
Using the contextual
.badge-* classes on an
<a> element quickly provide
actionable badges with hover and focus states.
<a href="#" class="badge badge-primary">Primary</a>
<a href="#" class="badge badge-secondary">Secondary</a>
<a href="#" class="badge badge-success">Success</a>
<a href="#" class="badge badge-danger">Danger</a>
<a href="#" class="badge badge-warning">Warning</a>
<a href="#" class="badge badge-info">Info</a>
<a href="#" class="badge badge-light">Light</a>
<a href="#" class="badge badge-dark">Dark</a>