Badge
Documentation and examples for badges, our small count and labeling component.
The frontend implementation differs slightly from the design. We are using a
line-height: 1;and rounded values for padding top and bottom, for more durability in all browsers and for all fonts. The missing space from the line-height is added to the padding top and bottom within SCSS. Use the variable$badge-line-heightto set the right line height. See the mixinbadge-padding-yif you want to reproduce our calculations. The pixel values could also differ by ± 1px, as different browsers round differently here.
Sizes#
There are three different sizes of the badge, that can be used. The default badge has the "basic" font-size. The .badge-large has the "large" font-style and the .badge-small has the "small" font-style. It's recommended to use the "large" variant for level 1 headlines, for the levels 2 - 4 the "basic" variant and for the levels below the "small" variant.
<h1>Example heading<span class="badge badge-primary badge-large ml-1">large</span>
</h1>
<h2>Example heading<span class="badge badge-primary ml-1">basic</span>
</h2>
<h3>Example heading<span class="badge badge-primary ml-1">basic</span>
</h3>
<h4>Example heading<span class="badge badge-primary ml-1">basic</span>
</h4>
<h5>Example heading<span class="badge badge-primary badge-small ml-1">small</span>
</h5>Contextual variations#
Add any of the below mentioned modifier classes to change the appearance of a badge. There is a modifier-class for all $theme-colors.
<span class="badge badge-primary mr-1">Primary</span>
<span class="badge badge-danger mr-1">Danger</span>
<span class="badge badge-gray mr-1">Gray</span>
<span class="badge badge-info">Info</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.
Addon badges#
Use the .badge-addon modifier class to make badges even smaller. This variant is perfect for discreet counters like in the header's usernavigation.
<span class="badge badge-addon badge-primary mr-1">9</span>
<span class="badge badge-addon badge-primary mr-1">99</span>
<span class="badge badge-addon badge-primary">99+</span>Accessibility#
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 or a link.
Unless the context is clear (as with the "Notifications" example, where it is understood that the "9" is the number of notifications), consider including additional context with a visually hidden piece of additional text like in the following example.
<span>Notifications<span class="badge badge-primary badge-addon ml-1">9</span>
<span class="sr-only">unread messages</span>
</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 mr-1">Primary</a>
<a href="#" class="badge badge-danger mr-1">Danger</a>
<a href="#" class="badge badge-gray mr-1">Gray</a>
<a href="#" class="badge badge-info">Info</a>Change log#
Changed#
SCSS: "Badge" | move calculation subtraction of border-width from paddings into the component SCSS instead of the configuration variables
Fixed#
SCSS: "Badge" | fixed padding to exclude the border size
Added#
Doc: "Badge" | Inform about the diff between frontend and design