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

a11y-announcer

v3.0.0

Published

An accessible ember route change announcer

Downloads

1,175

Readme

A11y-announcer

CI npm version

This addon is to allow for accessible route changes inside of your ember application. Currently when you change a route in ember nothing alerts a screen reader that the route has changed. This is very bad and screen reader users hear nothing but silence.

The goal for this addon is to fill the gaps in embers router. Thank you to @patrickfox for the idea!

How does it work?

The basic idea of this addon is to announce the new page title on every route change. This means the page title needs to change on every route. If it's routable, it's different enough to warrant a title change.

I use ember-cli-document-title to help me with manging the title of each route.

Getting Started

  • ember install a11y-announcer
  • Add <RouteAnnouncer/> to your application.hbs file.

Pushing updates to the announcer

Sometimes you want to push an announcement of some sort to the announcer. To do that you need to inject the announcer service:

import Controller from '@ember/controller';
import { inject as service } from '@ember/service';
import { action } from '@ember/object';

export default class IndexController extends Controller {

  @service announcer

  @action
  announceSomething() {
    this.announcer.announce('This is a test', 'assertive');
  }
}

Now that the service has been injected you can call the announce method: this.announcer.announce('Your Message', 'polite');

It takes two arguments. The first argument is the message that you want to be read off by the screen reader. The second argument is how aggressively the message will be read off. There are three different strings you can pass here:

  • off which means nothing will be read
  • polite which will not interrupt the screen reader
  • assertive which will immediately interrupt the screen reader

Changing the route change message

To change the route has changes message from ${pageTitle} has loaded to something custom (for example ${pageTitle} has finished loading) you will need to edit your Router in router.js:

var Router = Ember.Router.extend({
  location: config.locationType
  announcer: Ember.inject.service('announcer'),

  init() {
    this.super(...arguments);

    this.set('announcer.message', 'has finished loading');
  }
});

Installation

  • git clone this repository
  • npm install or yarn

Linting

  • ember server
  • Visit your app at http://localhost:4200.

Running tests

  • ember test
  • ember test --server

Running the dummy application

For more information on using ember-cli, visit http://www.ember-cli.com/.

See the Contributing guide for details.

License

This project is licensed under the MIT License.

Compatibility

  • Ember.js v3.12 or above
  • Ember CLI v2.13 or above
  • Node.js v10 or above