Skip to content

Commit

Permalink
docs(helpers): add "Visually hidden" page (#2674)
Browse files Browse the repository at this point in the history
Co-authored-by: Julien Déramond <[email protected]>
  • Loading branch information
vprothais and julien-deramond authored Aug 5, 2024
1 parent 17406cc commit 8d2844d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
22 changes: 21 additions & 1 deletion site/content/docs/0.0/helpers/visually-hidden.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}
<h2 class="visually-hidden">Title for screen readers</h2>
<a class="visually-hidden-focusable" href="#content">Skip to main content</a>
<div class="visually-hidden-focusable">A container with a <a href="#">focusable element</a>.</div>
{{< /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;
}
```
1 change: 0 additions & 1 deletion site/data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,6 @@
- title: Vertical rule
draft: true
- title: Visually hidden
draft: true

- title: Utilities
icon: braces-asterisk
Expand Down

0 comments on commit 8d2844d

Please sign in to comment.