{"id":15093035,"url":"https://github.com/angular/protractor-accessibility-plugin","last_synced_at":"2025-10-06T11:30:48.540Z","repository":{"id":57331841,"uuid":"45714013","full_name":"angular/protractor-accessibility-plugin","owner":"angular","description":"Runs a set of accessibility audits","archived":true,"fork":false,"pushed_at":"2018-04-03T13:46:33.000Z","size":208,"stargazers_count":267,"open_issues_count":20,"forks_count":37,"subscribers_count":28,"default_branch":"master","last_synced_at":"2024-09-26T11:03:03.945Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/angular.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-06T23:35:34.000Z","updated_at":"2024-07-31T23:30:02.000Z","dependencies_parsed_at":"2022-09-21T03:14:44.335Z","dependency_job_id":null,"html_url":"https://github.com/angular/protractor-accessibility-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular%2Fprotractor-accessibility-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular%2Fprotractor-accessibility-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular%2Fprotractor-accessibility-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/angular%2Fprotractor-accessibility-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/angular","download_url":"https://codeload.github.com/angular/protractor-accessibility-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219877267,"owners_count":16554853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-25T11:03:11.894Z","updated_at":"2025-10-06T11:30:43.202Z","avatar_url":"https://github.com/angular.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Accessibility Plugin\n====================\n\nProtractor comes with support for three accessibility testing options:\n * Accessibility Developer Tools\n * aXe Accessibility Engine\n * Tenon.io\n\nProtractor will run each set of audits (depending on your configuration) on your existing end-to-end\ntests to ensure your site is free of obvious errors. In this kind of testing, there is no concept of\n\"warnings\"–only pass or fail. In your configuration, you can decide whether warnings should\npass or fail your build.\n\nTo understand how each of these tools can be used, see this support matrix:\n\n| Testing Library                      | Pricing                                   | API Key | External Request | No. of Tests | Info                                                                    |\n|--------------------------------------|-------------------------------------------|---------|------------------|--------------|-------------------------------------------------------------------------|\n| Chrome Accessibility Developer Tools | Free                                      | No      | No               | 14           | [GitHub](https://github.com/GoogleChrome/accessibility-developer-tools) |\n| aXe Accessibility Engine             | Free                                      | No      | No               | 53           | [GitHub](https://github.com/dequelabs/axe-core/)    \n| Tenon.io                             | Free limited accounts, paid subscriptions | Yes     | Yes              | 63           | [Tenon.io](http://tenon.io/)                                            |                                        |\n\nProtractor now supports the [Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools), the same audit library used by the [Chrome browser extension](https://chrome.google.com/webstore/detail/accessibility-developer-t/fpkknkljclfencbdbgkenhalefipecmb?hl=en). Protractor\n[runs an audit](https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules)\nlocally by injecting the Dev Tools script into WebDriver pages, and it can diagnose issues including\nmissing labels, incorrect ARIA attributes and color contrast. This is a great starting point if\nyou can't send source code over the wire through an API.\n\n[aXe](https://github.com/dequelabs/axe-core) operates similarly to Chrome's Accessibility Developer Tools by injecting axe-core into all frames and checking the content against 53 [accessibility rules](https://github.com/dequelabs/axe-core/blob/master/doc/rule-descriptions.md).\n\n[Tenon.io](http://www.tenon.io) has a more robust set of tests to help you find\naccessibility issues, but it requires [registering](http://tenon.io/register.php) for an API key\nand making an external request for each test, which may not work for everyone. Some people use\nTenon with introspection services like ngrok or localtunnel to securely\ntest local web servers. Protractor takes the [options you provide](http://tenon.io/documentation/understanding-request-parameters.php) in the plugin configuration and sends them\nwith the page source to the Tenon API. One limitation of this approach is that all scripts must be reachable from the page source as a string, for example, by using a CDN.\nFor projects with an MIT license, Tenon is free but with a limited\ndaily API limit. Paid subscriptions are available for enterprise and commercial projects.\n\nEnable this plugin in your config file:\n```js\n  // Chrome Accessibility Dev Tools only:\n  exports.config = {\n      ...\n      plugins: [{\n        chromeA11YDevTools: {\n          treatWarningsAsFailures: true,\n          auditConfiguration: {\n            auditRulesToRun: [\n              'audioWithoutControls',\n              'badAriaAttributeValue',\n              'badAriaRole',\n              'controlsWithoutLabel',\n              'elementsWithMeaningfulBackgroundImage',\n              'focusableElementNotVisibleAndNotAriaHidden',\n              'imagesWithoutAltText',\n              'linkWithUnclearPurpose',\n              'lowContrastElements',\n              'mainRoleOnInappropriateElement',\n              'nonExistentAriaLabelledbyElement',\n              'pageWithoutTitle',\n              'requiredAriaAttributeMissing',\n              'unfocusableElementsWithOnClick',\n              'videoWithoutCaptions'\n            ],\n            auditRulesToSkip: []\n          }\n        },\n        package: 'protractor-accessibility-plugin'\n      }]\n    }\n```\n```js\n  // aXe only:\n  exports.config = {\n      ...\n      plugins: [{\n        axe: true,\n        package: 'protractor-accessibility-plugin'\n      }]\n    }\n```\n```js\n  // Tenon.io only:\n  exports.config = {\n      ...\n      plugins: [{\n        tenonIO: {\n          options: {\n            // See http://tenon.io/documentation/understanding-request-parameters.php\n            // options.src will be added by the test.\n          },\n          printAll: false, // whether the plugin should log API response\n        },\n        chromeA11YDevTools: true,\n        package: 'protractor-accessibility-plugin'\n      }]\n    }\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular%2Fprotractor-accessibility-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fangular%2Fprotractor-accessibility-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fangular%2Fprotractor-accessibility-plugin/lists"}