Skip to content

README.md

Latest commit

 

History

History
51 lines (31 loc) · 1.54 KB

README.md

File metadata and controls

51 lines (31 loc) · 1.54 KB

find

Finds potential accessibility gaps.

Usage

Inputs

urls

Required Newline-delimited list of URLs to check for accessibility issues. For example:

https://primer.style
https://primer.style/octicons/

auth_context

Optional Stringified JSON object containing username, password, cookies, and/or localStorage from an authenticated session. For example: {"username":"some-user","password":"correct-horse-battery-staple","cookies":[{"name":"theme-preference","value":"light","domain":"primer.style","path":"/"}],"localStorage":{"https://primer.style":{"theme-preference":"light"}}}

reduced_motion

Optional Playwright reducedMotion configuration option.

color_scheme

Optional Playwright colorScheme configuration option.

include_screenshots

Optional Bool - whether to capture screenshots of scanned pages and include links to them in the issue

scans

Optional Stringified JSON array of scans (string) to perform. If not provided, only Axe will be performed.

Outputs

findings_file

Absolute path to a JSON file containing the list of potential accessibility gaps. The action writes this file to a temporary directory and returns the absolute path. For example: $RUNNER_TEMP/findings-<uuid>.json.

The file will contain a JSON array of finding objects. For example:

[]