aboutsummaryrefslogtreecommitdiff
path: root/docs/4.1/utilities/screenreaders.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2018-04-09 09:00:23 -0700
committerGitHub <[email protected]>2018-04-09 09:00:23 -0700
commit8f7bd419935adfcd53c471a0202083464800619e (patch)
treed0e6ab018a0f41b59a1206cf72ffc79a474e69b9 /docs/4.1/utilities/screenreaders.md
parent91730a644f107ca80a747a6f7f0c173eca5708fa (diff)
downloadbootstrap-4.1.0.tar.xz
bootstrap-4.1.0.zip
Ship v4.1.0 (#26218)v4.1.0
* update docs path from docs/4.0/ to docs/4.1/ * bump version to 4.1.0 * Update redirects to work for 4.1 docs move * Update docs version switcher to include latest and link to 4.0 docs * re-run dist * Update package-lock.json * Update docs-navbar.html
Diffstat (limited to 'docs/4.1/utilities/screenreaders.md')
-rw-r--r--docs/4.1/utilities/screenreaders.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/4.1/utilities/screenreaders.md b/docs/4.1/utilities/screenreaders.md
new file mode 100644
index 000000000..311102c6a
--- /dev/null
+++ b/docs/4.1/utilities/screenreaders.md
@@ -0,0 +1,26 @@
+---
+layout: docs
+title: Screenreaders
+description: Use screenreader utilities to hide elements on all devices except screen readers.
+group: utilities
+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 -%}
+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 %}