Skip to content

Files

Latest commit

 

History

History

screen-reader

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Screen Automated Reader Enhanced Development (scare devs 🦁🔥💀)

Install

npx playwright install
npx @guidepup/setup

If errors occur after the automatic setup of Guidepup (e.g. no connection to Voiceover), the setup must be executed manually. See instructions.

Start

Start a test with these commands (ensure a build or start a watcher previous to running these commands to ensure that any expected changes within the code base will be reflected):

MacOS

npm run test:screen-reader:macos --workspace=react-showcase -- --ui

Windows

npm run test:screen-reader:windows --workspace=react-showcase -- --ui

Gotchas

  • Local: Don't switch in between your windows while testing, it will capture only your current screen
  • We should avoid auto-generate tests, because they take a lot of time.
  • NVDAs next command is equivalent of executing Down Arrow - Won't work with radio/select as you might expect
  • One simple test takes about 1 minute in CI ⬅ so you should only provide test important things

More information

We use this survey to reduce amount of tests (only for VoiceOver and NVDA).

Most common screen reader and browser combinations:

Screen Reader & Browser # of Respondents % of Respondents
NVDA with Chrome 323 21.3%
NVDA with Firefox 152 10.0%
VoiceOver with Safari 107 7.0%
NVDA with Edge 75 5.0%
VoiceOver with Chrome 30 2.0%

What operating system are you on when using your primary desktop/laptop screen reader?

Response # of respondents % of respondents
Windows 1311 86.1%
Mac 146 9.6%
Linux 44 2.9%
Other 21 1.4%

Conclusion: We only test Chrome for Windows and Safari for MacOS because these are the most common combinations.