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

docs: add list of required globals #1622

Merged
merged 1 commit into from
Jun 7, 2019
Merged

docs: add list of required globals #1622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions doc/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,18 @@ The axe API can be used as part of a broader process that is performed on many,

The axe APIs are provided in the javascript file axe.js. It must be included in the web page under test. Parameters are sent as javascript function parameters. Results are returned in JSON format.

### Required Globals

Axe requires a handful of global variables and interfaces to be available in order to run. See the [jsdom example](https://github.com/dequelabs/axe-core/blob/develop/doc/examples/jsdom/test/a11y.js) for how to set these up in a non-browser environment.

- `window`
- `document`
- [`navigator`](https://developer.mozilla.org/en-US/docs/Web/API/Window/navigator)
- [`Node`](https://developer.mozilla.org/en-US/docs/Web/API/Node)
- [`NodeList`](https://developer.mozilla.org/en-US/docs/Web/API/NodeList)
- [`Element`](https://developer.mozilla.org/en-US/docs/Web/API/Element)
- [`Document`](https://developer.mozilla.org/en-US/docs/Web/API/Document)

### Full API Reference for Developers

For a full listing of API offered by axe, clone the repository and run `npm run api-docs`. This generates `jsdoc` documentation under `doc/api` which can be viewed using the browser.
Expand Down