A simple way with Vue to announce any useful information for screen readers.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Update name package from vue-a11y-announcer to vue-announcer May 20, 2018
tests/e2e/integration Add example toasted test May 20, 2018
.babelrc Change babel transpiler to buble May 22, 2018
.eslintrc.js Initial config May 19, 2018
CHANGELOG.md chore(release): 1.0.2 May 24, 2018
LICENSE Initial commit May 19, 2018
README.md Update README May 24, 2018
package-lock.json chore(release): 1.0.2 May 24, 2018
rollup.config.dev.js Change babel transpiler to buble May 22, 2018
rollup.config.prod.js Change babel transpiler to buble May 22, 2018



Imagine browsing pages (routes), receiving alerts and notifications, having a countdown timer on the page, a progress bar or a loading, among others. Now imagine all this happening to people who have visual disabilities and who use screen readers.

The idea of this plugin is to tell the screen reader what is happening and primarily if you use single-page application.
Inspired by others in the community like:
https://haltersweb.github.io/Accessibility/spa.html (Example of how creating an accessible single-page application)
https://github.com/ember-a11y/a11y-announcer (Ember A11y community)

Install package


npm install -S vue-announcer


yarn add vue-announcer

How to use

In your main.js

import Vue from 'vue'
import VueAnnouncer from 'vue-announcer'


In your App.vue Example using vue-toasted

  <div id="app">
    <vue-announcer />

    <h2>App page</h2>
    <button type="button" data-va="toasted" @click="notify">
      trigger notification
export default {
  name: 'app'
  methods: {
    notify () {
      let message = `Hi, it's a toasted notification`
      this.$announcer.set(message) // Sets the message that will be read by the screen reader automatically.

See this example:
Example link

Announce route changes

For page changes (routes) to be announced automatically, you only need to pass the router object as a parameter at the time of installation.

import Vue from 'vue'
import router from './router'
import VueAnnouncer from 'vue-announcer'

Vue.use(VueAnnouncer, {}, router) 


Key Data Type default
complementRoute String has loaded


Vue.use(VueAnnouncer, {
  complementRoute: 'ha cargado' // e.g. in spanish
}, router) 

Custom message to each page (optional)

You can set a property on the meta object, which will serve as information to get the message that will be announced to the screen reader on each page. e.g.:

  name: 'home',
  path: '/',
  component: Home,
  meta: {
    announcer: 'Página de inicio'

When the page loads, the screen reader user will hear:

Página de inicio ha cargado


  • The plugin checks whether it was defined in the meta object, otherwise, without any problems, the title of the page being loaded will be used.
  • The vue-announcer uses the global after hooks router.afterEach to announce the route changes.

Check live demo


Run the tests

git clone https://github.com/vue-a11y/vue-announcer.git vue-announcer

// Run plugin
cd vue-announcer
npm install
npm run dev

// Run example
cd examples
npm install
npm run dev
cd ..

// Run Cypress testing
npm run test

Or run Cypress on interactive mode

npm run test:open

It is a simple webpack template already installed and configured. After the commands just access the http://localhost:8080/


  • Check the open issues or open a new issue to start a discussion around your feature idea or the bug you found;
  • Fork repository, make changes and send a pull request;

If you want a faster communication, find me on @ktquez And follow us on Twitter @vue_a11y

Thank you