diff options
Diffstat (limited to 'site/content/docs/5.0/helpers/screen-readers.md')
| -rw-r--r-- | site/content/docs/5.0/helpers/screen-readers.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/site/content/docs/5.0/helpers/screen-readers.md b/site/content/docs/5.0/helpers/screen-readers.md new file mode 100644 index 0000000000..501b9c311c --- /dev/null +++ b/site/content/docs/5.0/helpers/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: helpers +--- + +Hide an element to all devices **except screen readers** with `.sr-only`. Use `.sr-only-focusable` to show the element only when it's focused (e.g. by a keyboard-only user). Can also be used as mixins. + +{{< example >}} +<h2 class="sr-only">Title for screen readers</h2> +<a class="sr-only-focusable" href="#content">Skip to main content</a> +{{< /example >}} + +{{< highlight scss >}} +// Usage as a mixin + +.sr-only-title { + @include sr-only; +} + +.skip-navigation { + @include sr-only-focusable; +} +{{< /highlight >}} |