{"_id":"@advanced-rest-client/a11y-suite","_rev":"12-0a7bfdc37b96ad5d1377cae0ef4a6bde","name":"@advanced-rest-client/a11y-suite","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@advanced-rest-client/a11y-suite","version":"1.0.0","license":"Apache-2.0","_id":"@advanced-rest-client/a11y-suite@1.0.0","maintainers":[{"name":"jarrodek","email":"jarrodek@gmail.com"}],"contributors":[{"name":"Pawel Psztyc"},{"name":"The Advanced REST client authors","email":"arc@mulesoft.com"}],"homepage":"https://github.com/advanced-rest-client/a11y-suite#readme","bugs":{"url":"https://github.com/advanced-rest-client/a11y-suite/issues","email":"arc@mulesoft.com"},"dist":{"shasum":"c44bb5c188e67bed5dec263f23264ac425035b41","tarball":"https://registry.npmjs.org/@advanced-rest-client/a11y-suite/-/a11y-suite-1.0.0.tgz","fileCount":8,"integrity":"sha512-Ytecl7rJklQmqRQYp6P3WKSEv4z05E/+bld5ISVtEkbkaM2vS0Dzx7xKfp6xX+QoO0alCw0svgRBPR6zqg4sbg==","signatures":[{"sig":"MEYCIQCeWn6eWCog+UWcAS19QiAcRg/dDc6VAkXcLZSXyI8IvAIhAOKyqA8vt1EE/TDRootX5mV6oOOpkyQA/YG2jLFPTirP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5029,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdDu2YCRA9TVsSAnZWagAALsoP/01tvVQo5cDM2A2euDiM\nM2k3SwFBoatOOwHho1R7BPEQRRYJN/JBxIR74/IwWrLn489qPboAJF59OEx0\nfzW3P8cb/+s+XITR8wPEw8zumAF9ByqI1yH2zxpZx4tlyBSn9Ps73jvPlPwG\n1qRd6d1qG5sK7MKSoUMsxX8xjUkuSg8lp4cztjnGKLeBn7K274vqwGex5cHD\n3kNIQq7h3NUTfUo2OtqxF4mKYfTLbNUv1yzNATCNLLVfdUN4e/BQRrXweEje\n/d4iZf9/J+YpvGt7VT6FKRTxneqjaAbtyt9477N6eRABtN+0E7xSjj8tUFk7\n3mKU4fkoF2tMV0Gs197S+nBzWUVOWLnT+OGYzqs/VYokw+Yb3CaBI+8SJUZw\nCELnJyf65HzgdYqc5K4d64QUztFXGfJeS90Kh8J7OUD9DfYSccO7YbXjoO7Y\nJK+M/JAkccAQ/TbbjoKn4dHDcsZLoalmhn7re0qtrOEm1Qs7mcXZzjvmBBCy\n73KpBzjjaROlz8NerCTihxjoXy/P1s0kvw9d8JIxjV/eU6k8AZCOEd+bkGie\n0dv3ZHUGNKYaXiTldzT8nPlJ+sgUhp/mqkSW3615Takm5xsp9FAeck1DGJrP\n7SaDPDHNFxqQDdaJ1Ugjjy4wRLcS16OMCoCJW6T2FkbOxKqFxLOt5oAebG+Y\n1N59\r\n=XUCh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","authors":["Pawel Psztyc","The Advanced REST client authors <arc@mulesoft.com>"],"gitHead":"9f4c2dc081e410bcd4f314434e43296ea14f538e","scripts":{"lint":"npm run lint:eslint && npm run lint:prettier","test":"karma start --coverage","format":"npm run format:eslint && npm run format:prettier","test:watch":"karma start --auto-watch=true --single-run=false","lint:eslint":"eslint --ext .js,.html .","format:eslint":"eslint --ext .js,.html . --fix","lint:prettier":"prettier \"**/*.js\" --list-different || (echo '↑↑ these files are not prettier formatted ↑↑' && exit 1)","format:prettier":"prettier \"**/*.js\" --write"},"_npmUser":{"name":"jarrodek","email":"jarrodek@gmail.com"},"deprecated":"use @open-wc/testing instead","repository":{"url":"git://github.com/advanced-rest-client/a11y-suite.git","type":"git"},"_npmVersion":"6.9.0","description":"a11y suite to test accessibility of web components","directories":{},"lint-staged":{"*.js":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.15.3","dependencies":{"husky":"^1.0.0","lit-html":"^1.0.0","lint-staged":"^8.0.0","lit-element":"^2.0.1","@commitlint/cli":"^7.0.0","@open-wc/eslint-config":"^0.4.1","@open-wc/prettier-config":"^0.1.0","@commitlint/config-conventional":"^7.0.0"},"_hasShrinkwrap":false,"devDependencies":{"@open-wc/testing":"^0.11.1","@open-wc/testing-karma":"^2.0.6","accessibility-developer-tools":"^2.12.0"},"_npmOperationalInternal":{"tmp":"tmp/a11y-suite_1.0.0_1561259415330_0.9648084323881958","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@advanced-rest-client/a11y-suite","version":"1.0.1","license":"Apache-2.0","_id":"@advanced-rest-client/a11y-suite@1.0.1","maintainers":[{"name":"jarrodek","email":"jarrodek@gmail.com"}],"contributors":[{"name":"Pawel Psztyc"},{"name":"The Advanced REST client authors","email":"arc@mulesoft.com"}],"homepage":"https://github.com/advanced-rest-client/a11y-suite#readme","bugs":{"url":"https://github.com/advanced-rest-client/a11y-suite/issues","email":"arc@mulesoft.com"},"dist":{"shasum":"3b5e7084f06cf8b10e308c14dcfc39df2dbf9c68","tarball":"https://registry.npmjs.org/@advanced-rest-client/a11y-suite/-/a11y-suite-1.0.1.tgz","fileCount":8,"integrity":"sha512-job2pkw3ESCSwdq6RhafD1L238VOi+bErvaEPX86ulGL2TavoUIAAD44M98ZiOIFQSDeyZWtEWw8xaCUTLbRhQ==","signatures":[{"sig":"MEQCIF8GtEHjalKaTtMMTULB7rh9zuGZMWj/AtpFGwPMm43nAiB5p0w3QShdRwWSV63EcVb1Gvb5c1gB+Rf+FWwP30V46A==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5029,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdEAcjCRA9TVsSAnZWagAAxfkP/1yJ/9CJcpbOhK7NHfty\n10t9n6Mwa764B6ImAN0O5xdstRluJd8F9rF9PDyrEgoQ/bZFVs3J7u+V3F35\nSDdqwqiRy/LCuYiGPdHrQ5QSsZBxohuTXSH+ZIpq4e+oS9QSlpwJC2LZIX0a\npgw6dNHFW4FjEJIDO2q6bbJWJ8tVIJb0INqwEmh5Cs76aelGer2Y5adxd7j/\nGobVucF1Dg9kxdvnITAutT8+zbC+66EDfTejp+qq1ztmDFSirCM6gcFcWa0U\nh7v54Ag0M2o4M5zUQdqzgxE9pN+fhjGCMw4DqIY8tktjv4CRncs1CPJeuXzf\nZeBvBuRuJr1fXBLLF6McpRRY0+Aqy3VeiFekSVk0FIXmHlfZb3rvcF+Pffhm\nD+cJH98Q1cVGYdwuO5dzVoAozs1cxnszNzj4dIiqy5Tr4xKKbBzFbpt4Czj+\nmEMfQ+7zGzK4Ool6HX5OGyoHWKDfa03olDXYIz0BSf0AxxMqw423PwsWz7LQ\n6aXEOmnFppNvnIMekmgHmoFHaozsbjSDXrFiOGz8rUifskpF0kb8FWwvNhxo\nyUMaS1FWCLp+W54Bt/jUI2TM0MqszqtP4wyfsxVe6M0Oj8wh7wBPwy1fGC6s\n8pQKF3aMClQk3LotH0Eg6qyuikOmgj7aszuCfbOH95duR3v51SCSCUsVLJjw\nYU+w\r\n=RXnV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","authors":["Pawel Psztyc","The Advanced REST client authors <arc@mulesoft.com>"],"gitHead":"cd6188e14d6d92a9a152fdfad7ccd846e4cee560","scripts":{"lint":"npm run lint:eslint && npm run lint:prettier","test":"karma start --coverage","format":"npm run format:eslint && npm run format:prettier","test:watch":"karma start --auto-watch=true --single-run=false","lint:eslint":"eslint --ext .js,.html .","format:eslint":"eslint --ext .js,.html . --fix","lint:prettier":"prettier \"**/*.js\" --list-different || (echo '↑↑ these files are not prettier formatted ↑↑' && exit 1)","format:prettier":"prettier \"**/*.js\" --write"},"_npmUser":{"name":"jarrodek","email":"jarrodek@gmail.com"},"deprecated":"use @open-wc/testing instead","repository":{"url":"git://github.com/advanced-rest-client/a11y-suite.git","type":"git"},"_npmVersion":"6.9.0","description":"a11y suite to test accessibility of web components","directories":{},"lint-staged":{"*.js":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.15.3","dependencies":{"husky":"^1.0.0","lit-html":"^1.0.0","lint-staged":"^8.0.0","lit-element":"^2.0.1","@commitlint/cli":"^7.0.0","@open-wc/eslint-config":"^0.4.1","@open-wc/prettier-config":"^0.1.0","accessibility-developer-tools":"^2.12.0","@commitlint/config-conventional":"^7.0.0"},"_hasShrinkwrap":false,"devDependencies":{"@open-wc/testing":"^0.11.1","@open-wc/testing-karma":"^2.0.6"},"_npmOperationalInternal":{"tmp":"tmp/a11y-suite_1.0.1_1561331490915_0.2888657852531802","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@advanced-rest-client/a11y-suite","version":"1.1.0","license":"Apache-2.0","_id":"@advanced-rest-client/a11y-suite@1.1.0","maintainers":[{"name":"jarrodek","email":"jarrodek@gmail.com"}],"contributors":[{"name":"Pawel Psztyc"},{"name":"The Advanced REST client authors","email":"arc@mulesoft.com"}],"homepage":"https://github.com/advanced-rest-client/a11y-suite#readme","bugs":{"url":"https://github.com/advanced-rest-client/a11y-suite/issues","email":"arc@mulesoft.com"},"dist":{"shasum":"460ef01556d8a1b6de453487f418dd34f6d9409b","tarball":"https://registry.npmjs.org/@advanced-rest-client/a11y-suite/-/a11y-suite-1.1.0.tgz","fileCount":8,"integrity":"sha512-hrRS/1Dmp/st+6eEn5zSMhZziQeILx1lq4YfI6t+jV8QyWCZ62jBnL1XlUc8GW1/utR5bQyVmUzNSFVj0deMOA==","signatures":[{"sig":"MEUCIAH/ETSA/BNCOBdVMTizFxPD/QiuK/PQ/em8gVmM8BKQAiEA21kkx2G7p1AREPhbzZXUPYeJ0ZuQbGCE1CTRiOEPuig=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9390,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdMBQ0CRA9TVsSAnZWagAAt9sP/3sD/BMVWn3S/YvfjOcm\nUCWurd2HBeLvNN/p/w+zHCNv8A59tiKdo4YJ3AoWCMthJnRVPUw3R64Lp8AG\nD7w7n/3o99i0OSJLuBYP3cpQ4btPhLshdGGk/sBR8sDf0fF1wWU716fbRYoQ\na3FLgb8bG4kajy3886IaO2+auizo2bfPBb2WnIAgZEW55hXDyfA/ep0lASwc\n5gFJSx32xCj2o4poLmeMRDqHdIwvpokYl6lDzMsuk26bVesvCMBJlRdZc96y\nw4NwLqVVhIRzy0iSIqI3NASPr5lLPAJH0fzrk/WtqW7H1utfFZ+P29Mnksoh\ncCju75we4OsPm34+G/UwgPMmxoGvzY7tG8U9H6idPNSdxmb6ONhHMsHj1dm3\n6SfPLjdRWOnRnRmVW8kNQlUZlcK1mHsmLqqeD3bNdRbgAC5zr1nHBvok/K8+\noRsiHwHg9CveTNvWodfg/2DIEdBpSjGIA5vDQE2fQ0weccBS+DXwTnbcwi5p\nTDk5G4Yon1rBRsjtb4N4jK3QQ5CYlVAybiBoOIwrke5BaI5cy5qHNT4MMVWG\nDmjf6W7M708AhoMTyHxNVj2UVv5P6MzJY+X77AuyYtLWph9T1DC7aq4+LQVo\n7Mj8FOgKXOT64mKhi405ZYxPhYwWY/VLlAcLQxglKrRNbQwbzpy4ifchUmwQ\nG/Ix\r\n=yFIY\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","authors":["Pawel Psztyc","The Advanced REST client authors <arc@mulesoft.com>"],"gitHead":"601bc69a686cda1e3caa37a9b70200a835887c59","scripts":{"lint":"npm run lint:eslint && npm run lint:prettier","test":"karma start --coverage","format":"npm run format:eslint && npm run format:prettier","test:watch":"karma start --auto-watch=true --single-run=false","lint:eslint":"eslint --ext .js,.html .","format:eslint":"eslint --ext .js,.html . --fix","lint:prettier":"prettier \"**/*.js\" --list-different || (echo '↑↑ these files are not prettier formatted ↑↑' && exit 1)","format:prettier":"prettier \"**/*.js\" --write"},"_npmUser":{"name":"jarrodek","email":"jarrodek@gmail.com"},"deprecated":"use @open-wc/testing instead","repository":{"url":"git://github.com/advanced-rest-client/a11y-suite.git","type":"git"},"_npmVersion":"6.10.0","description":"a11y suite to test accessibility of web components","directories":{},"lint-staged":{"*.js":["eslint --fix","prettier --write","git add"]},"_nodeVersion":"10.16.0","dependencies":{"husky":"^1.0.0","axe-core":"^3.3.0","lit-html":"^1.1.1","lint-staged":"^8.0.0","lit-element":"^2.0.1","@commitlint/cli":"^8.1.0","@open-wc/eslint-config":"^0.4.1","@open-wc/prettier-config":"^0.1.0","@commitlint/config-conventional":"^7.0.0"},"_hasShrinkwrap":false,"devDependencies":{"@open-wc/testing":"^0.11.1","eslint-config-google":"^0.13.0","@open-wc/testing-karma":"^2.0.16"},"_npmOperationalInternal":{"tmp":"tmp/a11y-suite_1.1.0_1563431987542_0.1482080404259698","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-06-23T03:10:15.176Z","modified":"2026-04-07T19:29:58.888Z","1.0.0":"2019-06-23T03:10:15.490Z","1.0.1":"2019-06-23T23:11:31.045Z","1.1.0":"2019-07-18T06:39:47.670Z"},"bugs":{"url":"https://github.com/advanced-rest-client/a11y-suite/issues","email":"arc@mulesoft.com"},"license":"Apache-2.0","homepage":"https://github.com/advanced-rest-client/a11y-suite#readme","repository":{"url":"git://github.com/advanced-rest-client/a11y-suite.git","type":"git"},"description":"a11y suite to test accessibility of web components","contributors":[{"name":"Pawel Psztyc"},{"name":"The Advanced REST client authors","email":"arc@mulesoft.com"}],"maintainers":[{"email":"jarrodek@gmail.com","name":"jarrodek"},{"email":"alexperez@mulesoft.com","name":"alexperez_march_2024"},{"email":"elmellidiego@gmail.com","name":"dmacias"}],"readme":"## a11ySuite\n\nPerforms accessibility test using [axe-core](https://github.com/dequelabs/axe-core).\n\nIt accepts a template string from which a fixture is created or already created element. The later option is useful to perform accessibility test for the element at certain state.\n\nRules can be ignored by providing configuration option which accepts array of rule names to ignore.\n\n> This is temporary package until `@open-wc` implement similar functionality in their testing package.\n\n## Usage\n\n### Installation\n```sh\nnpm install --save-dev @advanced-rest-client/a11y-suite\n```\n\n### Running the tests\n\n```js\nimport { a11ySuite } from '@advanced-rest-client/a11y-suite/index.js';\nimport { fixture } from '@open-wc/testing';\n\nconst fix = await fixture(`<div role=\"listbox\">\n  <my-component>item</my-component>\n  </div>`);\n\ndescribe('<my-component>', () => {\n  a11ySuite('Normal state', fix);\n  a11ySuite('Disabled state', `<div role=\"listbox\"><my-component disabled>item</my-component></div>`);\n  a11ySuite('This passes error in axa', `<div aria-labelledby=\"non-existing-id\"></div><label id=\"my-id\">Title</label>`, ['badAriaAttributeValue']);\n});\n```\n\n### Ignoring rules\n\nThe test below passes even though it is invalid because the rule testing for valid aria attributes is disabled.\n\n```js\ndescribe('<my-component>', () => {\n  await a11ySuite('Test Suite', '<div aria-labelledby=\"test-x\"></div>', {\n    ignoredRules: ['aria-valid-attr-value']\n  });\n});\n```\n\n### Manipulating component's state before test\n\nYou can change the state of the component by creating a fixture before passing it to the suite or by passing `afterFixture` callback function that is invoked when fixture is created but before the test is performed.\n\n#### Direct state manipulation\n\n```js\nimport { a11ySuite } from '@advanced-rest-client/a11y-suite/index.js';\nimport { fixture, aTimeout } from '@open-wc/testing';\n\ndescribe('<my-component>', () => {\n  let element;\n  before(async () => {\n    element = await fixture(`<my-dialog>\n      <h1>Dialog</h1>\n    </my-dialog>`);\n  });\n\n  it('Passes a11y when opened', async () => {\n    element.opened = true;\n    async aTimeout();\n    await a11ySuite('Opened dialog', element);\n  });\n});\n```\n\n#### afterFixture callback\n\nIf `afterFixture` returns a promise then the test is executed when the promise is resolved.\n\n```js\nimport { a11ySuite } from '@advanced-rest-client/a11y-suite/index.js';\nimport { fixture, aTimeout } from '@open-wc/testing';\n\ndescribe('<my-component>', () => {\n  it('Passes a11y when opened', async () => {\n    await a11ySuite('Opened dialog', `<my-dialog><h1>Dialog</h1></my-dialog>`, {\n      afterFixture: async (element) => {\n        element.opened = true;\n        async aTimeout();\n      }\n    });\n  });\n});\n```\n\n## Development\n\n```sh\ngit clone https://github.com/advanced-rest-client/a11y-suite\ncd a11y-suite\nnpm install\n```\n\n## Running the tests\n```sh\nnpm test\n```\n","readmeFilename":"README.md"}