Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/coyote-labs/ember-accessibility
An EmberJS addon to help identify accessibility violations during development
https://github.com/coyote-labs/ember-accessibility
accessibility accessibility-testing ember ember-addon emberjs
Last synced: 22 days ago
JSON representation
An EmberJS addon to help identify accessibility violations during development
- Host: GitHub
- URL: https://github.com/coyote-labs/ember-accessibility
- Owner: coyote-labs
- License: mit
- Created: 2019-05-29T14:43:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-24T01:41:10.000Z (over 1 year ago)
- Last Synced: 2024-10-01T08:43:32.795Z (about 1 month ago)
- Topics: accessibility, accessibility-testing, ember, ember-addon, emberjs
- Language: JavaScript
- Homepage: https://coyote-labs.github.io/ember-accessibility/
- Size: 4.02 MB
- Stars: 33
- Watchers: 3
- Forks: 7
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - ember-accessibility - Addon to help identify accessibility violations during development. (Packages / a11y)
README
ember-accessibility
==============================================================================
[](https://www.npmjs.com/package/@coyote-labs/ember-accessibility) [](https://travis-ci.org/coyote-labs/ember-accessibility)
An EmberJS addon to help identify accessibility violations.
This addon uses the [axe-core](https://github.com/dequelabs/axe-core) library
to audit your apps.
[DEMO](https://coyote-labs.github.io/ember-accessibility/)
Compatibility
------------------------------------------------------------------------------
* Ember.js v3.24 or above
* Ember CLI v3.24 or above
* Node.js v12 or above
Installation
------------------------------------------------------------------------------
```
ember install @coyote-labs/ember-accessibility
```
Usage
------------------------------------------------------------------------------
* In your application template, include the **AccessibilityTester** component.
For example,
```handlebars
Welcome to my app!
```
* In your `config/environment.js`, provide an `ember-accessibility` object that has
the following fields.
`isEnabled`: Defaults to `false`. You can set it to `environment === 'development'`.
This addon's code will be stripped unless this is set to `true`.
`axe`: Allows configuring axe-core. Refer axe-core's [documentation](https://www.deque.com/axe/axe-for-web/documentation/api-documentation/#options-parameter).
```javascript
// config/environment.js
let ENV = {
'ember-accessibility': {
isEnabled: environment === 'development',
axe: {
restoreScroll: true
}
}
};
```
* Click on the **Check Accessiblity** button that appears when you visit the app.
* If you want to change the default position of the toggle, pass top and left position values to the `AccessibilityTester` component.
Note: Values are in pixels.
For example,
```handlebars
Welcome to my app!
```
* Fix the errors that are displayed and make your app accessible!
**Using in engines**
* Make sure you add `ember-accessibility` to the engine's dependencies.
* Add the `accessibility-test` service to your engine's dependencies in `app.js`.
**Using in test**
- Import the `auditAccessibility()` helper from `'@coyote-labs/ember-accessibility/test-support/audit';` and then invoke it where needed.
> Note: The config passed in `config/environment.js` will be applied here as well.
##### Acceptance Tests
```javascript
import auditAccessibility from '@coyote-labs/ember-accessibility/test-support/audit';
test('Checks accessibility violations', function(assert) {
visit('/');
assert.notOk(await auditAccessibility());
});
```
Or, you can pass any selector or element from the visited page.
```javascript
import auditAccessibility from '@coyote-labs/ember-accessibility/test-support/audit';
test('Checks accessibility violations', function(assert) {
visit('/');
assert.notOk(await auditAccessibility('#someID'));
});
```
##### Integration / Unit Tests
```javascript
import auditAccessibility from '@coyote-labs/ember-accessibility/test-support/audit';
test('Checks accessibility violations in component', function(assert) {
await render(hbs``);
assert.notOk(await auditAccessibility(this.element));
});
```
How is this different from [ember-a11y-testing](https://github.com/ember-a11y/ember-a11y-testing)?
------------------------------------------------------------------------------
ember-a11y-testing is primarily geared towards testing *as of now*. While this
will most definitely change, we wanted something that will provide contextual
and meaningful feedback to developers during the development phase itself.
For example, here is how ember-a11y-testing looks in development currently.
Notice how all the errors are present on the console. This addon on the other hand
will make it easier to comprehend those errors.
Another major reason that we wrote this addon is because our tests became
extremely slow when using ember-a11y-testing. This is a major pain point when
using it on large projects. By doing a11y testing in development and review
phases, we were able to avoid that.
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.
License
------------------------------------------------------------------------------
This project is licensed under the [MIT License](LICENSE.md).