Configuration options in Accessibility Automation
Customise accessibility testing which is conducted within your test suite.
Accessibility testing options
Add the accessibilityOptions key along with one of the keys mentioned in the basic & advanced sections below to customise your testing.
Basic settings
Options
Here are the basic settings which you can customise:
| Use-case | Key | Description | Values |
|---|---|---|---|
| Specify WCAG version | wcagVersion |
Specify the WCAG ruleset which is targeted during automatic issue detection. Default: wcag21aa
|
wcag2a, wcag2aa, wcag2aaa, wcag21a, wcag21aa, wcag21aaa
|
| Include or exclude Best practice issues |
bestPractice (add under includeIssueType) |
Issues marked as Best practices aren’t Accessibility guideline violations, but resolving them will improve the overall user experience. Default: false
|
true OR false
|
| Include or exclude Needs review issues |
needsReview (add under includeIssueType) |
Issues marked as Needs Review needs manual inspection to confirm it’s validity. Default: true
|
true OR false
|
| Include test cases | includeTagsInTestingScope |
Test cases with these tags, annotations or groups will be included in the accessibility testing scope. Learn more | List of test case tags |
| Exclude test cases | excludeTagsInTestingScope |
Test cases with these tags, annotations or groups will be excluded from the accessibility testing scope. Learn more | List of test case tags |
Example
For examples of includeTagsInTestingScope or excludeTagsInTestingScope visit Specify testing scope.
Advanced settings
Options
Here are the advanced settings which you can customise:
| Use-case | Key | Description | Values |
|---|---|---|---|
| Scanner processing timeout (in secs) | scannerProcessingTimeout |
When a test case ends, our scanner will wait for the timeout duration, after which processing will completely stop and the test case report will be generated. You can increase this timeout, if issues are not detected. Default: 5 secs
|
0 - 30 |
Example
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Is this page helping you?
Yes
No
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!
