Docs: rename "Screen readers" helper page to "Visually hidden"

"screen readers" is quite reductive, as there are other assistive technologies. content hidden this way is even announced by things like Alexa/Siri etc, so it's not so much just "screen readers".
in the long run, we may even consider changing the actual classnames (maybe `.visually-hidden` / `.visually-hidden-focusable`, though admittedly that's a bit verbose).

also includes a tiny tweak to layout.md to generalise the note about using `.sr-only`

diff --git a/scss/_helpers.scss b/scss/_helpers.scss
index 1fdbc2959d161a3d9a7535bbf48934c6f7f85349..2fb66e4eac0c1a8463fbfcf613ef78233833b98e 100644 (file)
--- a/scss/_helpers.scss
+++ b/scss/_helpers.scss
@@ -2,6 +2,6 @@
 @import "helpers/colored-links";
 @import "helpers/embed";
 @import "helpers/position";
-@import "helpers/screenreaders";
+@import "helpers/visually-hidden";
 @import "helpers/stretched-link";
 @import "helpers/text-truncation";

diff --git a/scss/helpers/_screenreaders.scss b/scss/helpers/_visually-hidden.scss
similarity index 83%
rename from scss/helpers/_screenreaders.scss
rename to scss/helpers/_visually-hidden.scss
index 8bade663395daf10a1d5bdc507aba36c2cae1dd6..0a843d383de2693db0121126f4b411812ee858f3 100644 (file)
--- a/scss/helpers/_screenreaders.scss
+++ b/scss/helpers/_visually-hidden.scss
@@ -1,5 +1,5 @@
 //
-// Screenreaders
+// Visually hidden
 //
 
 .visually-hidden,

diff --git a/site/content/docs/5.0/forms/layout.md b/site/content/docs/5.0/forms/layout.md
index a97a7e9e5a60cc3961e5c39097cc8f72532657c7..3a4d0e7fa10d7e0d62da29edac9496e6290ec280 100644 (file)
--- a/site/content/docs/5.0/forms/layout.md
+++ b/site/content/docs/5.0/forms/layout.md
@@ -297,7 +297,7 @@ You can then remix that once again with size-specific column classes.
 
 Use the `.col-auto` class to create horizontal layouts. By adding [gutter modifier classes]({{< docsref "/layout/gutters" >}}), we'll have gutters in horizontal and vertical directions. The `.align-items-center` aligns the form elements to the middle, making the `.form-checkbox` align properly.
 
-Be sure to always include a `<label>` with each form control, even if you need to hide it from non-screenreader visitors with `.visually-hidden`.
+Be sure to always include a `<label>` with each form control, even if you need to visually hide it with `.visually-hidden` (which still keeps it available to assistive technologies such as screen readers).
 
 {{< example >}}
 <form class="row row-cols-md-auto g-3 align-items-center">

diff --git a/site/content/docs/5.0/helpers/visually-hidden.md b/site/content/docs/5.0/helpers/visually-hidden.md
new file mode 100644 (file)
index 0000000..7f8c21a
--- /dev/null
+++ b/site/content/docs/5.0/helpers/visually-hidden.md
@@ -0,0 +1,25 @@
+---
+layout: docs
+title: Visually hidden
+description: Use these helpers to visually hide elements but keep them accessible to assistive technologies.
+group: helpers
+---
+
+Visually hide an element while still allowing it to be exposed to assistive technologies (such as screen readers) with `.sr-only`. Use `.sr-only-focusable` to visually hide an element by default, but to display it 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 >}}

diff --git a/site/data/sidebar.yml b/site/data/sidebar.yml
index 195cf3af3bf40441a0788b9924a2f1c1d7cfbc45..5550c30750d8ad63542fa42ea9a6478a3378fe22 100644 (file)
--- a/site/data/sidebar.yml
+++ b/site/data/sidebar.yml
@@ -81,7 +81,7 @@
     - title: Colored links
     - title: Embed
     - title: Position
-    - title: Screen readers
+    - title: Visually hidden
     - title: Stretched link
     - title: Text truncation