Skip to content

Commit

Permalink
docs(a11y): Linked between pages. Rearranged sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
hellogreg committed Oct 2, 2024
1 parent 68a5aec commit 6d3a88d
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 33 deletions.
9 changes: 1 addition & 8 deletions docs/accessibility/screen-readers-computer.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
---
title: "Screen readers: computer"
sidenavTitle: "Screen readers: computer"
title: "Computer screen readers"
permalink: /accessibility/screen-readers-computer/index.html
tags:
- accessibility
order: 101
---

On computers, screen reader testing often lets you perform two tests simultaneously. First, it ensures that all meaningful web content and interactions are available to assistive tech. Second, it helps you verify that your experiences are keyboard operable (which is a [WCAG requirement](https://www.w3.org/WAI/WCAG21/Understanding/keyboard-accessible.html)).

After turning on your computer’s screen reader and opening your browser, use your keyboard to access the entire experience, top to bottom. Use the <kbd>Tab</kbd>, <kbd>Shift-Tab</kbd>, and <kbd>↑ → ↓ ←</kbd> keys to move among (and within) focusable elements like links, form controls, and interactive components. And you can then use other keys like <kbd>Space</kbd>, <kbd>Enter</kbd>, and <kbd>Escape</kbd> to interact with those elements.

Each screen reader also has its own set of keyboard shortcuts to navigate and read non-interactive content within an experience. Different keypresses can start (or stop) reading the page, jump to the next heading element, move vertically and horizontally among table cells, and so on. Links to keyboard shortcut resources are included in each screen reader’s section, below.

## VoiceOver (macOS)

- VoiceOver is included with MacOS.
Expand Down
6 changes: 1 addition & 5 deletions docs/accessibility/screen-readers-mobile.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
title: "Screen readers: mobile"
sidenavTitle: "Screen readers: mobile"
title: "Mobile screen readers"
permalink: /accessibility/screen-readers-mobile/index.html
tags:
- accessibility
order: 102
---

On mobile devices, you will use touchscreen gestures and taps instead of a keyboard to navigate the page and activate interactive elements.
For basic navigation, you can swipe right, left, up, and down with one finger to move forward and backward through the page, and then double-tap to activate form controls and links. Each platform has many other gestures for more advanced navigation. View the linked gesture shortcuts pages within each section for more guidance.

## VoiceOver (iOS)

- VoiceOver is included with iOS.
Expand Down
76 changes: 56 additions & 20 deletions docs/accessibility/screen-readers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Screen readers
sidenavTitle: Screen reader testing
sidenavTitle: Screen readers
permalink: /accessibility/screen-readers/index.html
tags:
- accessibility
Expand All @@ -14,17 +14,12 @@ importElements:
href="/assets/packages/@rhds/elements/elements/rh-tile/rh-tile-lightdom.css">

<style>
rh-tile {
margin-block: var(--rh-space-3xl, 48px);
max-width: 320px;
}

rh-tile [slot="headline"] {
font-weight: var(--rh-font-weight-heading-bold, 700);
}
</style>

Our screen reader testing pages provide some quick guidance for starting, stopping, and changing the settings of various screen readers. They also offer screen-reader-specific bonus tips and links to third-party resources like keyboard/gesture shortcut guides.
Here, we provide some quick guidance for starting, stopping, and changing the settings of various readers. Each how-to section offers screen-reader-specific bonus tips and links to third-party resources like keyboard/gesture shortcut guides.

## Why test with screen readers?

Expand All @@ -34,6 +29,60 @@ When testing with screen readers, our goal is to verify that an assistive tech u
2. Can you accomplish all the same tasks with and without assistive tech (e.g. navigating the site, submitting forms, adding items to a cart, etc.)?
3. When page contents are read, are you presented with all the meaningful info you would expect as a visual user? (This includes status updates on dynamic pages.)

## Computer screen readers

On computers, screen reader testing often lets you perform two tests simultaneously:

1. It ensures that all meaningful web content and interactions are available to assistive tech.
2. It helps you verify that your experiences are keyboard operable (which is a [WCAG requirement](https://www.w3.org/WAI/WCAG21/Understanding/keyboard-accessible.html)).

After turning on your computer’s screen reader and opening your browser, use your keyboard to access the entire experience, top to bottom. Use the <kbd>Tab</kbd>, <kbd>Shift-Tab</kbd>, and <kbd>↑ → ↓ ←</kbd> keys to move among (and within) focusable elements like links, form controls, and interactive components. And you can then use other keys like <kbd>Space</kbd>, <kbd>Enter</kbd>, and <kbd>Escape</kbd> to interact with those elements.

Each screen reader also has its own set of keyboard shortcuts to navigate and read non-interactive content within an experience. Different keypresses can start (or stop) reading the page, jump to the next heading element, move vertically and horizontally among table cells, and so on. Links to keyboard shortcut resources are included in each screen reader’s section.

### How to use computer screen readers

<nav class="grid xs-two-columns sm-three-columns">
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-computer/#voiceover-(macos)">VoiceOver (macOS)</a></h3>
VoiceOver is a screen reader that comes packaged with macOS.
</rh-tile>
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-computer/#nvda-(windows)">NVDA (Windows)</a></h3>
NVDA is a free, downloadable screen reader for Windows.
</rh-tile>
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-computer/#jaws-(windows)">JAWS (Windows)</a></h3>
JAWS is a paid, downloadable screen reader for Windows.
</rh-tile>
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-computer/#narrator-(windows)">Narrator (Windows)</a></h3>
Narrator comes packaged with Windows 10 and 11.
</rh-tile>
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-computer/#orca-(linux)">Orca (Linux)</a></h3>
Orca comes packaged with GNOME and other desktop environments.
</rh-tile>
</nav>

## Mobile screen readers

On mobile devices, you will use touchscreen gestures and taps instead of a keyboard to navigate the page and activate interactive elements.
For basic navigation, you can swipe right, left, up, and down with one finger to move forward and backward through the page, and then double-tap to activate form controls and links. Each platform has many other gestures for more advanced navigation. View the linked gesture shortcuts pages within each section for more guidance.

### How to use mobile screen readers

<nav class="grid xs-two-columns sm-three-columns">
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-mobile/#voiceover-(ios)">VoiceOver (iOS)</a></h3>
VoiceOver comes preinstalled on iOS and iPadOS devices.
</rh-tile>
<rh-tile compact="">
<h3 slot="headline"><a href="/accessibility/screen-readers-mobile/#talkback-(android)">Talkback (Android)</a></h3>
TalkBack comes preinstalled on Android devices.
</rh-tile>
</nav>

## Browser and screen reader pairings

If you can only test on one platform, it never hurts to try your screen reader with as many browsers as possible. For example, if you only have a Mac, go ahead and pair VoiceOver with Safari, Chrome, and Firefox.
Expand All @@ -47,16 +96,3 @@ But if you’re either pressed for time or have access to multiple operating sys
- Linux: Firefox and Orca
- iOS: Safari and VoiceOver
- Android: Chrome and TalkBack

<rh-tile compact="">
<h2 slot="headline"><a href="#top">Link1</a></h2>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</rh-tile>
<rh-tile compact="">
<h2 slot="headline"><a href="#top">Link2</a></h2>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</rh-tile>
<rh-tile compact="">
<h2 slot="headline"><a href="#top">Link3</a></h2>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</rh-tile>

0 comments on commit 6d3a88d

Please sign in to comment.