1
0
Fork 0
mirror of https://github.com/twbs/bootstrap.git synced 2022-11-09 12:25:43 -05:00

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`
This commit is contained in:
Patrick H. Lauke 2020-06-21 12:07:20 +01:00 committed by Mark Otto
parent 49934b2bba
commit 3a79335a0b
5 changed files with 29 additions and 4 deletions

View file

@ -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";

View file

@ -1,5 +1,5 @@
//
// Screenreaders
// Visually hidden
//
.visually-hidden,

View file

@ -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">

View file

@ -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 >}}

View file

@ -81,7 +81,7 @@
- title: Colored links
- title: Embed
- title: Position
- title: Screen readers
- title: Visually hidden
- title: Stretched link
- title: Text truncation