Accessibility Scanning

Jump to bottom

Kevin Day edited this page Aug 31, 2022 · 1 revision

There are several tools available to perform scanning against accessibility standards, such as:

This guide goes over utilizing the AXE tool from a terminal.

Scanning TAMU Library Components

The components can be scanned using the AXE tool to help meet WCAG 2.1 AA. This requires two terminals to perform.

The first terminal is for starting up the service from within an already downloaded or cloned components repository.

npm install
npm run build
npm run start

Once the service is successfully running in the first terminal, then in the second terminal perform the following steps.

If the AXE tool is not already installed, then install it:

npm install @axe-core/cli -g

Run the AXE tool against the site with the appropriate tag, such as wcag21aa for WCAG 2.1 AA.

axe http://localhost:3000/ --tags wcag21aa --save tamu-library-components.json

If --tags wcag21aa is not specified, then the default of processing all available rules is performed.
If --save tamu-library-components.json is not specified, then the tamu-library-components.json file containing the results is not generated.

References