aboutsummaryrefslogtreecommitdiff
path: root/site/content/docs/5.1/helpers/visually-hidden.md
diff options
context:
space:
mode:
authorXhmikosR <[email protected]>2021-09-07 21:49:51 +0300
committerGitHub <[email protected]>2021-09-07 21:49:51 +0300
commit65413de3131294cbf7bc8bff94914cc8062149c6 (patch)
treed606f927ef9d5e505245b0fce29366979d219f83 /site/content/docs/5.1/helpers/visually-hidden.md
parent72e79d0e3997c3a850263880240f26684b9784f7 (diff)
parent0d81d3cbc14dfcdca8a868e3f25189a4f1ab273c (diff)
downloadbootstrap-docs-offcanvas-navbar.tar.xz
bootstrap-docs-offcanvas-navbar.zip
Merge branch 'main' into docs-offcanvas-navbardocs-offcanvas-navbar
Diffstat (limited to 'site/content/docs/5.1/helpers/visually-hidden.md')
-rw-r--r--site/content/docs/5.1/helpers/visually-hidden.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/site/content/docs/5.1/helpers/visually-hidden.md b/site/content/docs/5.1/helpers/visually-hidden.md
new file mode 100644
index 000000000..245546994
--- /dev/null
+++ b/site/content/docs/5.1/helpers/visually-hidden.md
@@ -0,0 +1,29 @@
+---
+layout: docs
+title: Visually hidden
+description: Use these helpers to visually hide elements but keep them accessible to assistive technologies.
+group: helpers
+aliases: "/docs/5.1/helpers/screen-readers/"
+---
+
+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;
+}
+```