3.5 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Badges | Documentation and examples for badges, our small count and labeling component. | components | true |
Examples
Badges scale to match the size of the immediate parent element by using relative font sizing and em units. As of v5, badges no longer have focus or hover styles for links.
Headings
{{< example >}}
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
{{< /example >}}Buttons
Badges can be used as part of links or buttons to provide a counter.
{{< example >}} Notifications 4 {{< /example >}}
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.
Positioned
Use utilities to modify a .badge and position it in the corner of a link or button.
{{< example >}} Inbox 99+ unread messages {{< /example >}}
You can also replace the .badge class with a few more utilities without a count for a more generic indicator.
{{< example >}} Profile New alerts {{< /example >}}
Background colors
Use our background utility classes to quickly change the appearance of a badge. Please note that when using Bootstrap's default .bg-light, you'll likely need a text color utility like .text-dark for proper styling. This is because background utilities do not set anything but background-color.
{{< example >}} {{< badge.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }}{{- end -}} {{< /badge.inline >}} {{< /example >}}
{{< callout info >}} {{< partial "callout-warning-color-assistive-technologies.md" >}} {{< /callout >}}
Pill badges
Use the .rounded-pill utility class to make badges more rounded with a larger border-radius.
{{< example >}} {{< badge.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }}{{- end -}} {{< /badge.inline >}} {{< /example >}}
Sass
Variables
{{< scss-docs name="badge-variables" file="scss/_variables.scss" >}}