Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating README to indicate the need to use query param with global setup helper #240

Merged
merged 3 commits into from
Mar 2, 2021
Merged

Updating README to indicate the need to use query param with global setup helper #240

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ff4ac1
docs: Updating README to indicate the need to use query param with gl…
scalvert Mar 2, 2021
7eb8444
Fixing borked format
scalvert Mar 2, 2021
d9f5ada
Changing callout emoji
scalvert Mar 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ setupGlobalA11yHooks(() => true);
start();
```

:warning: It's important to note that you must also use the [`enableA11yAudit`](#force-running-audits) query parameter in order to force audits. This setting is required in addition to any invocation strategy you provide.

#### Setting Options using `setRunOptions`

You can provide options to axe-core for your tests using the `setRunOptions` API. This API is helpful if you don't have access to the `a11yAudit` calls directly, such as when using the `setupGlobalA11yHooks`, or if you want to set the same options for all tests in a module.
Expand Down