aboutsummaryrefslogtreecommitdiff
path: root/site/docs/4.3/utilities/screen-readers.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2019-02-11 11:15:34 -0800
committerGitHub <[email protected]>2019-02-11 11:15:34 -0800
commit1ded0d6a4eefb7daca62c44e4e735aec200f0b6f (patch)
treee0036e5068cfb8e2c17971c4e892bd6b502dda9a /site/docs/4.3/utilities/screen-readers.md
parent3aa0770b711f69c4dcf5858b8913794e81b32d80 (diff)
downloadbootstrap-4.3.0.tar.xz
bootstrap-4.3.0.zip
Release v4.3.0 (#28228)v4.3.0
* Prep for v4.3.0 * More updates for v4.3.0. * rerun to build docs source map
Diffstat (limited to 'site/docs/4.3/utilities/screen-readers.md')
-rw-r--r--site/docs/4.3/utilities/screen-readers.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/site/docs/4.3/utilities/screen-readers.md b/site/docs/4.3/utilities/screen-readers.md
new file mode 100644
index 000000000..c38ba3e65
--- /dev/null
+++ b/site/docs/4.3/utilities/screen-readers.md
@@ -0,0 +1,25 @@
+---
+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 %}