Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badge counter example and accessibility advice #23060

Merged
merged 1 commit into from
Jul 12, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/4.0/components/badge.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,36 @@ Badges scale to match the size of the immediate parent element by using relative
<h6>Example heading <span class="badge badge-secondary">New</span></h6>
{% endhighlight %}

Badges can be used as part of links or buttons to provide a counter.

<div class="bd-example">
<button class="btn">
Notifications <span class="badge badge-secondary">4</span>
</button>
</div>

{% highlight html %}
<button class="btn">
Notifications <span class="badge badge-secondary">4</span>
</button>
{% endhighlight %}

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 arguably understandable that the "4" gives a count of the number of notifications), consider including additional context – for instance using a visually hidden piece of additional text.

<div class="bd-example">
<button class="btn">
Profile <span class="badge badge-secondary">9</span>
<span class="sr-only">unread messages</span>
</button>
</div>

{% highlight html %}
<button class="btn">
Profile <span class="badge badge-secondary">9</span>
<span class="sr-only">unread messages</span>
</button>
{% endhighlight %}

## Contextual variations

Add any of the below mentioned modifier classes to change the appearance of a badge.
Expand Down