diff options
| author | Patrick H. Lauke <[email protected]> | 2020-06-21 12:07:20 +0100 |
|---|---|---|
| committer | Mark Otto <[email protected]> | 2020-07-10 16:00:50 -0700 |
| commit | 3a79335a0b21cc5bbd3f133e63aec6052694fc20 (patch) | |
| tree | 9285fc2b764d7f809cb814e47bfeb607b7a5b870 | |
| parent | 49934b2bba514582c92bd423f94ddbf890bc3a66 (diff) | |
| download | bootstrap-3a79335a0b21cc5bbd3f133e63aec6052694fc20.tar.xz bootstrap-3a79335a0b21cc5bbd3f133e63aec6052694fc20.zip | |
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`
| -rw-r--r-- | scss/_helpers.scss | 2 | ||||
| -rw-r--r-- | scss/helpers/_visually-hidden.scss (renamed from scss/helpers/_screenreaders.scss) | 2 | ||||
| -rw-r--r-- | site/content/docs/5.0/forms/layout.md | 2 | ||||
| -rw-r--r-- | site/content/docs/5.0/helpers/visually-hidden.md | 25 | ||||
| -rw-r--r-- | site/data/sidebar.yml | 2 |
5 files changed, 29 insertions, 4 deletions
diff --git a/scss/_helpers.scss b/scss/_helpers.scss index 1fdbc2959..2fb66e4ea 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 index 8bade6633..0a843d383 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 a97a7e9e5..3a4d0e7fa 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 `<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 index 000000000..7f8c21a14 --- /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 195cf3af3..5550c3075 100644 --- 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 |
