aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick H. Lauke <[email protected]>2017-07-13 00:25:40 +0100
committerGitHub <[email protected]>2017-07-13 00:25:40 +0100
commitc00437ec1b47d1ec9c7e0b181afec87c2c480631 (patch)
treef2bd5011f5140116553af3ccb72c87fee9b2ca93 /docs
parentb14c5cc4b8c23c5630d2520cab7e5d8ef1556049 (diff)
downloadbootstrap-c00437ec1b47d1ec9c7e0b181afec87c2c480631.tar.xz
bootstrap-c00437ec1b47d1ec9c7e0b181afec87c2c480631.zip
Add badge counter example and accessibility advice
Diffstat (limited to 'docs')
-rw-r--r--docs/4.0/components/badge.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/4.0/components/badge.md b/docs/4.0/components/badge.md
index e2d92b08b..4e80828a4 100644
--- a/docs/4.0/components/badge.md
+++ b/docs/4.0/components/badge.md
@@ -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.