From cdea25584dc7a074d099931c5be77fe3fb5fde20 Mon Sep 17 00:00:00 2001 From: "Patrick H. Lauke" Date: Fri, 31 Jul 2020 10:27:36 +0100 Subject: [PATCH] Cleanup/fix after the sr-only to visually-hidden renaming (#31359) * sr-only -> visually-hidden cleanup It seems the old screen-readers.md file was left behind, and forgot to rename the mixin * Fix broken mixins for visually-hidden --- scss/_mixins.scss | 2 +- ...reen-reader.scss => _visually-hidden.scss} | 6 ++--- .../docs/5.0/helpers/screen-readers.md | 25 ------------------- 3 files changed, 4 insertions(+), 29 deletions(-) rename scss/mixins/{_screen-reader.scss => _visually-hidden.scss} (83%) delete mode 100644 site/content/docs/5.0/helpers/screen-readers.md diff --git a/scss/_mixins.scss b/scss/_mixins.scss index 8c00f31d25..7b06cd8198 100644 --- a/scss/_mixins.scss +++ b/scss/_mixins.scss @@ -12,7 +12,7 @@ @import "mixins/breakpoints"; @import "mixins/image"; @import "mixins/resize"; -@import "mixins/screen-reader"; +@import "mixins/visually-hidden"; @import "mixins/reset-text"; @import "mixins/text-truncate"; diff --git a/scss/mixins/_screen-reader.scss b/scss/mixins/_visually-hidden.scss similarity index 83% rename from scss/mixins/_screen-reader.scss rename to scss/mixins/_visually-hidden.scss index e5ee63c094..26edfe84be 100644 --- a/scss/mixins/_screen-reader.scss +++ b/scss/mixins/_visually-hidden.scss @@ -1,11 +1,11 @@ // stylelint-disable declaration-no-important -// Only display content to screen readers +// Hide content visually while keeping it accessible to assistive technologies // // See: https://a11yproject.com/posts/how-to-hide-content/ // See: https://hugogiraudel.com/2016/10/13/css-hide-and-seek/ -@mixin visually-hidden { +@mixin visually-hidden() { position: absolute !important; width: 1px !important; height: 1px !important; @@ -21,7 +21,7 @@ // // Useful for "Skip to main content" links; see https://www.w3.org/TR/2013/NOTE-WCAG20-TECHS-20130905/G1 -@mixin visually-hidden-focusable { +@mixin visually-hidden-focusable() { &:not(:focus) { @include visually-hidden(); } diff --git a/site/content/docs/5.0/helpers/screen-readers.md b/site/content/docs/5.0/helpers/screen-readers.md deleted file mode 100644 index fd9ca88879..0000000000 --- a/site/content/docs/5.0/helpers/screen-readers.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: docs -title: Screen readers -description: Use screen reader utilities to hide elements on all devices except screen readers. -group: helpers ---- - -Hide an element to all devices **except screen readers** with `.visually-hidden`. Use `.visually-hidden-focusable` to show the element only when it's focused (e.g. by a keyboard-only user). Can also be used as mixins. - -{{< example >}} -

Title for screen readers

-Skip to main content -{{< /example >}} - -{{< highlight scss >}} -// Usage as a mixin - -.visually-hidden-title { - @include visually-hidden; -} - -.skip-navigation { - @include visually-hidden-focusable; -} -{{< /highlight >}}