a11y/README.md

Runs an accessibility audit against a URL

<img width="400px" src="https://cloud.githubusercontent.com/assets/110953/4694241/3ddba98e-57c1-11e4-852a-dc0940345a89.png">

# [![npm version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image] ![](https://img.shields.io/badge/unicorn-approved-ff69b4.svg)

> Easy accessibility audits powered by the [Chrome Accessibility Tools](https://www.npmjs.com/package/accessibility-developer-tools)

![](http://i.imgur.com/Mt751vA.png)


## Install

```console
$ npm install --global a11y
```

*PhantomJS, which is used for generating the screenshots, is installed automagically, but in some [rare cases](https://github.com/Obvious/phantomjs/issues/102) it might fail to and you'll get an `Error: spawn EACCES` error. [Download](http://phantomjs.org/download.html) PhantomJS manually and reinstall `a11y` if that happens.*


## CLI usage

Run an audit against a URL:

```console
$ a11y todomvc.com
```

Or multiple URLs:

```console
$ a11y todomvc.com google.com
```


## Example

![](http://i.imgur.com/3xg3Fsf.png)

Also works fine against localhost:

```console
$ a11y localhost:9000
```

And local files:

```console
$ a11y index.html
```

![](http://i.imgur.com/Ffkrr9D.png)

Even with [glob](https://github.com/isaacs/node-glob#glob) patterns:

```console
$ a11y '**/*.html'
```

## Options

### Query help:

```console
$ a11y --help
```

### Customise viewport size

Type: `string`<br>
Default: `1024x768`

```console
$ a11y --viewport-size=800x600
```

### Set a custom delay before capturing the page

Type: `number` *(seconds)*<br>
Default: `1`

```console
$ a11y --delay=5
```

Useful when the site does things after load that you want to capture.

### Verbose mode:

```console
$ a11y <url> --verbose
```

### Write audit to file:

```console
$ a11y <url> > audit.txt
```


## Module usage

Audit a remote URL and generate an accessibility report:

```js
const a11y = require('a11y');

a11y('twitter.com', (err, reports) => {
    const audit = reports.audit; // `a11y` Formatted report
    const report = reports.report; // DevTools Accessibility Audit formatted report
});
```

Work with the output of `reports.audit`:

```js
const a11y = require('a11y');

a11y('twitter.com', (err, reports) => {
    for (const report of reports) {
        // Result will be PASS, FAIL or NA
        if (report.result === 'FAIL') {
            // el.heading
            // el.severity
            // el.elements
        }
    }
});
```

Passing options:

```js
const a11y = require('a11y');

const options = {
    viewportSize: '800x600'
};

a11y('twitter.com', options, (err, reports) => {
    // ...
});
```

Currently, the only suported option is:

  - `viewportSize` (String in format WIDTHxHEIGHT, eg `800x600`)


## Interpreting results

To interpret how to fix individual issues in an audit, see the [Audit Rules](https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules) section of the Accessibility Developer Tools project.

Per the Accessibility Developer Tools, the results in an audit may be one of three types:

* `PASS` - implies that there were elements on the page that may potentially have failed this audit rule, but they passed. Congratulations!
* `FAIL` - This implies that there were elements on the page that did not pass this audit rule. This is the only result you will probably be interested in.
* `NA` - This implies that there were no elements on the page that may potentially have failed this audit rule. For example, an audit rule that checks video elements for subtitles would return this result if there were no video elements on the page.


## Build-system integration

If you use Grunt, [`grunt-a11y`](https://github.com/lucalanca/grunt-a11y) is a task by João Figueiredo that uses `a11y` under the hood.


## Status

At this time, this module should be relatively reliable when auditing for accessibility issues in static sites.

We are actively working on exploring support for complex web-applications, including those using JavaScript libraries such as Polymer, Angular and React/Flux. We hope to bring this work to the main master branch once it is considered stable.


## License

Apache-2.0

[npm-url]: https://npmjs.org/package/a11y
[npm-image]: https://badge.fury.io/js/a11y.svg
[travis-url]: https://travis-ci.org/addyosmani/a11y
[travis-image]: https://travis-ci.org/addyosmani/a11y.svg?branch=master
[daviddm-url]: https://david-dm.org/addyosmani/a11y.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/addyosmani/a11y