Components
Badges
Documentation and examples for badges, our small count and labeling component.
View page source on GitHubOn this page
Examples#
Badges are small pill-shaped labels and counters. Unlike Bootstrap's, felt-css badges have a fixed size (.75rem) and don't scale with the parent element; set --felt-badge-font-size: .75em to have them scale like Bootstrap's. Like in Bootstrap 5, badges have no focus or hover styles for links.
Headings#
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
<h1>Example heading <span class="badge text-bg-secondary">New</span></h1>
<h2>Example heading <span class="badge text-bg-secondary">New</span></h2>
<h3>Example heading <span class="badge text-bg-secondary">New</span></h3>
<h4>Example heading <span class="badge text-bg-secondary">New</span></h4>
<h5>Example heading <span class="badge text-bg-secondary">New</span></h5>
<h6>Example heading <span class="badge text-bg-secondary">New</span></h6>Buttons#
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 text-bg-secondary">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. 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.
Positioned#
Use utilities to modify a .badge and position it in the corner of a link or button.
<button type="button" class="btn btn-primary position-relative">
Inbox
<span class="position-absolute top-0 start-100 translate-middle badge rounded-pill bg-danger">
99+
<span class="visually-hidden">unread messages</span>
</span>
</button>You can also replace the .badge class with a few more utilities without a count for a more generic indicator.
<button type="button" class="btn btn-primary position-relative">
Profile
<span class="position-absolute top-0 start-100 translate-middle p-2 bg-danger border border-light rounded-circle">
<span class="visually-hidden">New alerts</span>
</span>
</button>Background colors#
Set a background-color with contrasting foreground color with the .text-bg-{color} helpers. Pairing .text-{color} and .bg-{color} utilities works too.
<span class="badge text-bg-primary">Primary</span>
<span class="badge text-bg-secondary">Secondary</span>
<span class="badge text-bg-success">Success</span>
<span class="badge text-bg-danger">Danger</span>
<span class="badge text-bg-warning">Warning</span>
<span class="badge text-bg-info">Info</span>
<span class="badge text-bg-light">Light</span>
<span class="badge text-bg-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 like screen readers. Make sure the meaning is obvious from the content itself, or is included through alternative means such as additional text hidden with the .visually-hidden class.
In the felt look a coloured badge is a small patch: saturated felt with a cut edge and a soft shadow, but no seam.
Pill badges#
felt-css badges are pills by default (--felt-badge-border-radius), so .rounded-pill changes nothing on them; it's kept here so Bootstrap markup works unchanged. For a squarer badge, use a .rounded-* utility such as .rounded-2.
<span class="badge rounded-pill text-bg-primary">Primary</span>
<span class="badge rounded-pill text-bg-secondary">Secondary</span>
<span class="badge rounded-pill text-bg-success">Success</span>
<span class="badge rounded-pill text-bg-danger">Danger</span>
<span class="badge rounded-pill text-bg-warning">Warning</span>
<span class="badge rounded-pill text-bg-info">Info</span>
<span class="badge rounded-pill text-bg-light">Light</span>
<span class="badge rounded-pill text-bg-dark">Dark</span>Legend dots#
An extra, not in Bootstrap: .badge-dot turns an empty badge into a small round colour key, e.g. for a chart's series. It takes a .text-bg-{color} fill, a colour of its own in --felt-badge-dot-color, or otherwise the text colour. A legend is a list of dots with their labels:
- House 52 %
- Battery 17 %
- Grid 31 %
- Car 9 %
<ul class="list-unstyled d-flex flex-wrap column-gap-3 row-gap-1 small mb-0">
<li><span class="badge badge-dot text-bg-primary"></span> House 52 %</li>
<li><span class="badge badge-dot text-bg-success"></span> Battery 17 %</li>
<li><span class="badge badge-dot text-bg-info"></span> Grid 31 %</li>
<li><span class="badge badge-dot" style="--felt-badge-dot-color: #b5651d"></span> Car 9 %</li>
</ul>In the felt look a dot is a tiny patch of saturated felt, like the coloured badges. In both looks its rim leans towards the text colour, so light and dark dots stand apart from the surface.
CSS#
Variables#
Badges are built on local CSS variables, like Bootstrap's: .badge declares them, and you can set them on any badge. On a solid .bg-* fill a badge sets --felt-badge-color to the fill's ink.
| Token | Default | Bootstrap |
|---|---|---|
--felt-badge-padding-x | .6rem | --bs-badge-padding-x |
--felt-badge-padding-y | .2rem | --bs-badge-padding-y |
--felt-badge-font-size | .75rem | --bs-badge-font-size |
--felt-badge-font-weight | 700 | --bs-badge-font-weight |
--felt-badge-color | var(--felt-body-color) | --bs-badge-color |
--felt-badge-border-radius | var(--felt-radius-pill) | --bs-badge-border-radius |