From 30ddcafb2d51c96385273efd1f6b653196728cb1 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Thu, 7 Feb 2019 11:29:06 +0200 Subject: Rename `Screenreaders` to "Screen readers". No redirect is added because the next version will be a minor version bump. --- site/_data/nav.yml | 2 +- site/docs/4.2/utilities/screen-readers.md | 25 +++++++++++++++++++++++++ site/docs/4.2/utilities/screenreaders.md | 25 ------------------------- 3 files changed, 26 insertions(+), 26 deletions(-) create mode 100644 site/docs/4.2/utilities/screen-readers.md delete mode 100644 site/docs/4.2/utilities/screenreaders.md diff --git a/site/_data/nav.yml b/site/_data/nav.yml index 3c1017607..664be04da 100644 --- a/site/_data/nav.yml +++ b/site/_data/nav.yml @@ -66,7 +66,7 @@ - title: Image replacement - title: Overflow - title: Position - - title: Screenreaders + - title: Screen readers - title: Shadows - title: Sizing - title: Spacing diff --git a/site/docs/4.2/utilities/screen-readers.md b/site/docs/4.2/utilities/screen-readers.md new file mode 100644 index 000000000..c38ba3e65 --- /dev/null +++ b/site/docs/4.2/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 %} +Skip to main content +{% endcapture %} +{% include example.html content=example %} + +{% highlight scss %} +// Usage as a mixin +.skip-navigation { + @include sr-only; + @include sr-only-focusable; +} +{% endhighlight %} diff --git a/site/docs/4.2/utilities/screenreaders.md b/site/docs/4.2/utilities/screenreaders.md deleted file mode 100644 index e543bc9f2..000000000 --- a/site/docs/4.2/utilities/screenreaders.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: docs -title: Screenreaders -description: Use screenreader 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 %} -Skip to main content -{% endcapture %} -{% include example.html content=example %} - -{% highlight scss %} -// Usage as a mixin -.skip-navigation { - @include sr-only; - @include sr-only-focusable; -} -{% endhighlight %} -- cgit v1.2.3