# @vue-a11y/announcer

> A simple way with Vue to announce any information to the screen readers.

Latest version **2.1.0** (published 2020-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vue-a11y/announcer
pnpm add @vue-a11y/announcer
yarn add @vue-a11y/announcer
bun add @vue-a11y/announcer
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2020-09-01 |
| First published | 2020-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 72.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 237 |
| Author | Alan Ktquez |
| Maintainers | kddeisz, ktquez, mlama007 |
| Keywords | announcer, Vue.js, Vue, accessibility, a11y, screen, readers, Vision, Disability, JAWS, ChromeVox, NVDA |

## Links

- npm: https://www.npmjs.com/package/@vue-a11y/announcer
- Repository: https://github.com/vue-a11y/vue-announcer
- Homepage: https://vue-a11y.github.io/vue-announcer/
- Issues: https://github.com/vue-a11y/vue-announcer/issues
- npm.io page: https://npm.io/package/@vue-a11y/announcer

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2020-09-01
- 3.1.5 (next) — 2021-07-15
- 3.1.3 (beta) — 2021-04-08
- 3.1.4 — 2021-04-08
- 3.1.2 — 2021-01-24
- 3.1.1 — 2021-01-24
- 3.1.0 — 2021-01-24
- 3.0.6 — 2021-01-19
- 3.0.5 — 2021-01-19
- 3.0.4 — 2021-01-19
- 3.0.3 — 2021-01-19
- 3.0.2 — 2021-01-19
- 3.0.1 — 2021-01-19
- 3.0.0-beta.3 — 2021-01-19
- 3.0.0-beta.2 — 2021-01-19
- … 5 more at https://npm.io/package/@vue-a11y/announcer/versions

## README

# Introduction

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

The [@vue-a11y/announcer](https://github.com/vue-a11y/vue-announcer) (v2) provides an easy way to really tell what’s going on in your application to people using screen readers.

> For vue-announcer version 1.* you can access [this link](https://github.com/vue-a11y/vue-announcer/tree/v1.0.6)

Inspired by others in the community like:  
- [Example of how creating an accessible single-page application](https://haltersweb.github.io/Accessibility/spa.html)
- [Ember A11y community](https://github.com/ember-a11y/a11y-announcer)

## Links

- [Documentation](https://vue-announcer-v2.surge.sh)
- [Demos](https://vue-announcer-v2.surge.sh/demos/)

## Run the tests
```shell
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
```shell
npm run test:open
```

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


## Contributing
- From typos in documentation to coding new features;
- 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;

Follow us on Twitter [@vue_a11y](https://twitter.com/vue_a11y)

**Thank you**

---
_Source: https://npm.io/package/@vue-a11y/announcer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._