aboutsummaryrefslogblamecommitdiffstats
path: root/vendor/twbs/bootstrap/site/docs/4.4/utilities/screen-readers.md
blob: c38ba3e65eb697dc2b590fcf9562c2c2e3261ec0 (plain) (tree)
1
2
3
4
5

            

                                                                                               
                



















                                                                                                                                                                                                                              
---
layout: docs
title: Screen readers
description: Use screen reader utilities to hide elements on all devices except screen readers.
group: utilities
---

Hide an element to all devices **except screen readers** with `.sr-only`. Combine `.sr-only` with `.sr-only-focusable` to show the element again when it's focused (e.g. by a keyboard-only user). Can also be used as mixins.

{%- comment -%}
Necessary for following [accessibility best practices]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/#accessibility).
{%- endcomment -%}

{% capture example %}
<a class="sr-only sr-only-focusable" href="#content">Skip to main content</a>
{% endcapture %}
{% include example.html content=example %}

{% highlight scss %}
// Usage as a mixin
.skip-navigation {
  @include sr-only;
  @include sr-only-focusable;
}
{% endhighlight %}