2.9 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | Badges | Documentation and examples for badges, our small count and labeling component. | components | true |
Example
Badges scale to match the size of the immediate parent element by using relative font sizing and em units.
{{< example >}}
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
Example heading New
{{< /example >}}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.
{{< example >}} Profile 9 unread messages {{< /example >}}
Contextual variations
Add any of the below mentioned modifier classes to change the appearance of a badge.
{{< example >}} {{< badge.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }}{{- end -}} {{< /badge.inline >}} {{< /example >}}
{{< callout warning >}} {{< partial "callout-warning-color-assistive-technologies.md" >}} {{< /callout >}}
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.
{{< example >}} {{< badge.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }}{{- end -}} {{< /badge.inline >}} {{< /example >}}
Links
Using the contextual .badge-* classes on an <a> element quickly provide actionable badges with hover and focus states.
{{< example >}} {{< badge.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ .name | title }}{{- end -}} {{< /badge.inline >}} {{< /example >}}