From 3a79335a0b21cc5bbd3f133e63aec6052694fc20 Mon Sep 17 00:00:00 2001 From: "Patrick H. Lauke" Date: Sun, 21 Jun 2020 12:07:20 +0100 Subject: [PATCH] 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` --- scss/_helpers.scss | 2 +- ...reenreaders.scss => _visually-hidden.scss} | 2 +- site/content/docs/5.0/forms/layout.md | 2 +- .../docs/5.0/helpers/visually-hidden.md | 25 +++++++++++++++++++ site/data/sidebar.yml | 2 +- 5 files changed, 29 insertions(+), 4 deletions(-) rename scss/helpers/{_screenreaders.scss => _visually-hidden.scss} (83%) create mode 100644 site/content/docs/5.0/helpers/visually-hidden.md diff --git a/scss/_helpers.scss b/scss/_helpers.scss index 1fdbc2959d..2fb66e4eac 100644 --- 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 8bade66339..0a843d383d 100644 --- 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 a97a7e9e5a..3a4d0e7fa1 100644 --- 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 `