Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ember-a11y/a11y-announcer
An accessible ember route change announcer
https://github.com/ember-a11y/a11y-announcer
Last synced: 4 days ago
JSON representation
An accessible ember route change announcer
- Host: GitHub
- URL: https://github.com/ember-a11y/a11y-announcer
- Owner: ember-a11y
- License: mit
- Created: 2015-09-07T07:13:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T17:04:03.000Z (almost 2 years ago)
- Last Synced: 2024-10-08T12:21:49.978Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://ember-a11y.github.io/a11y-announcer
- Size: 4.28 MB
- Stars: 44
- Watchers: 7
- Forks: 6
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ember - a11y-announcer - An accessible ember route change announcer. (Packages / a11y)
README
# A11y-announcer
[](https://npmjs.org/package/a11y-announcer "View this project on npm")
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!](https://vimeo.com/117614181)
## 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](https://github.com/kimroen/ember-cli-document-title) to help me with manging the title of each route.
### Getting Started
- `ember install a11y-announcer`
- Add `` 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:
```js
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`:
```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
* `ember serve`
* Visit the dummy application at [http://localhost:4200](http://localhost:4200).
For more information on using ember-cli, visit [http://www.ember-cli.com/](http://www.ember-cli.com/).
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).
## Compatibility
* Ember.js v3.12 or above
* Ember CLI v2.13 or above
* Node.js v10 or above