twbs--bootstrap/docs/4.1/utilities/screenreaders.md

27 lines
853 B
Markdown
Raw Normal View History

---
layout: docs
title: Screenreaders
description: Use screenreader utilities to hide elements on all devices except screen readers.
group: utilities
2017-05-28 18:25:59 +00:00
toc: true
---
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 -%}
2017-05-29 18:38:06 +00:00
Necessary for following [accessibility best practices]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/#accessibility).
{%- endcomment -%}
2018-03-14 15:44:38 +00:00
{% capture example %}
<a class="sr-only sr-only-focusable" href="#content">Skip to main content</a>
2018-03-14 15:44:38 +00:00
{% endcapture %}
{% include example.html content=example %}
{% highlight scss %}
// Usage as a mixin
.skip-navigation {
@include sr-only;
@include sr-only-focusable;
}
{% endhighlight %}