You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-8Lines changed: 16 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,11 +73,11 @@ Check out the configuration this adds [in the `config.ts` file](./src/config.ts)
73
73
74
74
### Web Content Navigation
75
75
76
-
In addition to the Guidepup APIs the `voiceOver` and `nvda` instances provided by the Guidepup Playwright setup have an additional utility method `.navigateToWebContent()`.
76
+
In addition to the Guidepup APIs the `screenReader`, `voiceOver`, and `nvda` instances provided by the Guidepup Playwright setup have an additional utility method `.navigateToWebContent()`.
77
77
78
78
This method will navigate the screen reader to the first element of the document body in the browser.
79
79
80
-
Use this method after you navigate to a page and have made any necessary checks that the page has loaded as expected. For example, this is how you might use the method with NVDA:
80
+
Use this method after you navigate to a page and have made any necessary checks that the page has loaded as expected. For example, this is how you might use the method:
@@ -119,14 +119,22 @@ or pass a flag to prevent log clearing:
119
119
// ... some commands
120
120
121
121
// Navigate to the web content
122
-
await nvda.navigateToWebContent(false);
122
+
await screenReader.navigateToWebContent(false);
123
123
124
124
// ... some commands
125
125
```
126
126
127
127
### Providing Screen Reader Start Options
128
128
129
-
The options provided to `nvda.start([options])` or `voiceOver.start([options])` can be configured using `test.use(config)` as follows:
129
+
The options provided to `screenReader.start([options])`, `nvda.start([options])`, or `voiceOver.start([options])` can be configured using `test.use(config)` as follows:
130
+
131
+
```ts
132
+
// Screen Reader Example
133
+
import { screenReaderTest as test } from "@guidepup/playwright";
134
+
135
+
// Capture all spoken phrases, including usage hints
0 commit comments