Badge
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.
<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.
<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
).
<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>
Examples
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-primary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-secondary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-success badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-info badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-warning badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-danger badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-light badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-dark badge-pos rounded-circle">2</span>
</button>
Border Style
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-primary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-secondary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-success badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-info badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-warning badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-danger badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-light badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-dark mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-outline-dark badge-pos rounded-circle">2</span>
</button>
Sizes
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-xs badge-primary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-sm badge-primary badge-pos rounded-circle">2</span>
</button>
<button class="btn btn-xs btn-icon btn-text-secondary mx-2" type="button">
<span class="fas fa-shopping-cart btn-icon__inner"></span>
<span class="badge badge-md badge-primary badge-pos rounded-circle">2</span>
</button>
<span class="badge badge-pill badge-primary badge-bigger">Primary</span>
Avatar & Badges
<div class="d-inline-block position-relative u-avatar m-3">
<img class="img-fluid rounded-circle" src="../assets/img/img1.jpg" alt="Image Description">
<span class="badge badge-xs badge-outline-success badge-pos rounded-circle"></span>
</div>
<span class="btn btn-icon btn-success rounded m-3">
<span class="btn-icon__inner">JB</span>
<span class="badge badge-md badge-outline-primary badge-pos badge-pos--bottom-right rounded-circle"></span>
</span>
<span class="btn btn-icon btn-soft-light gradient-half-primary-v1 m-3">
<span class="btn-icon__inner">AO</span>
<span class="badge badge-xs badge-outline-success badge-pos badge-pos--bottom-left rounded-circle"></span>
</span>
<div class="d-inline-block position-relative u-avatar m-3">
<img class="img-fluid rounded" src="../assets/img/img1.jpg" alt="Image Description">
<span class="badge badge-xs badge-outline-warning badge-pos badge-pos--top-left rounded-circle"></span>
</div>
<span class="btn btn-icon btn-soft-danger rounded-circle m-3">
<span class="btn-icon__inner">AO</span>
<span class="badge badge-sm badge-outline-danger badge-pos badge-pos--bottom-left rounded-circle"></span>
</span>