README.md

accessibility-checker-extension

Browser extensions integrated with the web developer tools (DEvTools) that add automated accessibility checking, automated keyboard checking visualizations, and reporting capabilities.

The extensions are supporting components of the IBM Equal Access Toolkit. The Toolkit provides the tools and guidance to create experiences that are delightful for people of all abilities. The guidance is organized by phase, such as Plan, Design, Develop, and Verify, and explains how to integrate the automated testing tools into the Verify phase. The Toolkit is a major part of the accessibility information and applications at ibm.com/able.

Usage

The extensions have been deployed to the various stores so they can be easily downloaded and installed:

• Chrome Web Store extension : web browser extension that integrates automated accessibility checking capabilities into the Chrome Developer Tools
• Firefox Add-on extension : web browser extension that integrates automated accessibility checking capabilities into the Firefox Web Developer Tools
• Edge Add-on extension : web browser extension that integrates automated accessibility checking capabilities into the Edge Developer Tools.

The browser extensions provide an integrated checking experience and visualizations to help users quickly identify the source of accessibility issues and try fixes.

Requirements for building and running locally

• Node Version 18.

Install dependencies

1. Under the root equal-access directory

   npm install

Build

There are several different modes that you can run with. These will build the extension to accessibility-checker-extension/dist (See loading into the browser below)

Run local extension with local rule server

1. Under the rule-server directory, npm start
2. Open https://localhost:9445 in your browser and accept any self-signed certs. In chrome you may need to type 'thisisunsafe', which will accept the cert (you will not actually see anywhere to type it). You should get "Cannot GET /".
3. On a new command line window, under the accessibility-checker-extension directory, npm run build:watch:local

Run local extension with production rule server

From the accessibility-checker-extension directory:

• To continuously build when changes occur, npm run build:watch
• To build once for development, npm run build:dev
• To build for production, npm run build:prod

Loading into the browser developer tools

In Chrome web browser

1. Go to: chrome://extensions
2. Toggle: "developer mode" on.
3. Click on: "Load unpacked"
4. Select the newly created folder "dist" equal-access/accessibility-checker-extension/dist from the project folder.

In Firefox web browser

1. Go to: about:debugging in the Firefox browser
2. Select: "This Firefox"
3. Click on: "Load Temporary Add-on…"
4. Open the newly created folder "dist" from the project folder, and choose the "manifest.json" file.

Build the deployment package for Chrome and Firefox

npm run clean:all
npm install
npm run package:browser

The commands generate a package/accessibility-checker-extension.zip file. The zip package can be deployed into the Chrome or Firefox store. Test the package locally in the Firefox browser:

1. Go to: about:debugging in the Firefox browser
2. Select: "This Firefox"
3. Click on: "Load Temporary Add-on…"
4. Open the newly created package file "accessibility-checker-extension.zip" from the package folder.

Feedback and reporting bugs

If you think you've found a bug, have questions or suggestions, open a GitHub Issue, tagged with extension-checker.

If you are an IBM employee, feel free to ask questions in the IBM internal Slack channel #accessibility-at-ibm.

License