diff --git a/site/content/docs/0.0/helpers/visually-hidden.md b/site/content/docs/0.0/helpers/visually-hidden.md index a3054a36f5..174e4d05c5 100644 --- a/site/content/docs/0.0/helpers/visually-hidden.md +++ b/site/content/docs/0.0/helpers/visually-hidden.md @@ -9,4 +9,24 @@ aliases: - "/docs/0.0/helpers/screen-readers/" --- -{{< callout-soon "helper" >}} +Visually hide an element while still allowing it to be exposed to assistive technologies (such as screen readers) with `.visually-hidden`. Use `.visually-hidden-focusable` to visually hide an element by default, but to display it when it's focused (e.g. by a keyboard-only user). `.visually-hidden-focusable` can also be applied to a container–thanks to `:focus-within`, the container will be displayed when any child element of the container receives focus. + +{{< example >}} +

Title for screen readers

+Skip to main content +
A container with a focusable element.
+{{< /example >}} + +Both `visually-hidden` and `visually-hidden-focusable` can also be used as mixins. + +```scss +// Usage as a mixin + +.visually-hidden-title { + @include visually-hidden; +} + +.skip-navigation { + @include visually-hidden-focusable; +} +``` diff --git a/site/data/sidebar.yml b/site/data/sidebar.yml index 28a61c340b..001c774757 100644 --- a/site/data/sidebar.yml +++ b/site/data/sidebar.yml @@ -204,7 +204,6 @@ - title: Vertical rule draft: true - title: Visually hidden - draft: true - title: Utilities icon: braces-asterisk