npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@coyote-labs/ember-accessibility

v4.0.0

Published

An EmberJS addon to help identify accessibility violations

Downloads

633

Readme

ember-accessibility

Latest npm release TravisCI Build Status

An EmberJS addon to help identify accessibility violations.

This addon uses the axe-core library to audit your apps.

DEMO

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,

    <h1>Welcome to my app!</h1>
    <AccessibilityTester />
  • 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.

    // 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,

    <h1>Welcome to my app!</h1>
    <AccessibilityTester @top="25" @left="750"/>
  • 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
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.

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
import auditAccessibility from '@coyote-labs/ember-accessibility/test-support/audit';

test('Checks accessibility violations in component', function(assert) {
  await render(hbs`<AccessibilityTester />`);  
  assert.notOk(await auditAccessibility(this.element));
});

How is this different from 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 guide for details.

License

This project is licensed under the MIT License.