Skip to content

Commit

Permalink
Merge pull request #240 from ember-a11y/update-readme-global-setup
Browse files Browse the repository at this point in the history
Updating README to indicate the need to use query param with global setup helper
  • Loading branch information
Andrew A Lee committed Mar 2, 2021
2 parents 6ccbc1d + d9f5ada commit e56803c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
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

0 comments on commit e56803c

Please sign in to comment.