# @polymer/iron-a11y-announcer
> A singleton element that simplifies announcing text to screen readers.
Latest version **3.2.0** (published 2021-04-30) · BSD-3-Clause license · 0 weekly downloads
## Install
```sh
npm install @polymer/iron-a11y-announcer
pnpm add @polymer/iron-a11y-announcer
yarn add @polymer/iron-a11y-announcer
bun add @polymer/iron-a11y-announcer
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.2.0 |
| Published | 2021-04-30 |
| First published | 2016-02-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 26 |
| Author | The Polymer Authors |
| Maintainers | aomarks, emarquez, sorvell, bicknellr, usergenic, polymer-devs, azakus, justinfagnani, tvanderlippe, straversi |
| Keywords | web-components, polymer, a11y, live |
## Links
- npm: https://www.npmjs.com/package/@polymer/iron-a11y-announcer
- Repository: https://github.com/PolymerElements/iron-a11y-announcer
- Homepage: https://github.com/PolymerElements/iron-a11y-announcer#readme
- Issues: https://github.com/PolymerElements/iron-a11y-announcer/issues
- npm.io page: https://npm.io/package/@polymer/iron-a11y-announcer
## Dependencies (1)
- [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0
## Recent versions
- 3.2.0 (latest) — 2021-04-30
- 3.0.0-pre.20 (next) — 2018-06-23
- 1.0.5-pre.3 (preview) — 2017-01-24
- 3.1.0 — 2020-06-08
- 3.0.2 — 2018-11-12
- 3.0.1 — 2018-09-14
- 3.0.0 — 2018-09-13
- 3.0.0-pre.26 — 2018-09-12
- 3.0.0-pre.25 — 2018-08-29
- 3.0.0-pre.24 — 2018-08-29
- 3.0.0-pre.23 — 2018-08-25
- 3.0.0-pre.22 — 2018-08-25
- 3.0.0-pre.21 — 2018-06-23
- 3.0.0-pre.19 — 2018-05-09
- 3.0.0-pre.18 — 2018-05-09
- … 20 more at https://npm.io/package/@polymer/iron-a11y-announcer/versions
## README
[](https://www.npmjs.com/package/@polymer/iron-a11y-announcer)
[](https://travis-ci.org/PolymerElements/iron-a11y-announcer)
[](https://webcomponents.org/element/@polymer/iron-a11y-announcer)
## <iron-a11y-announcer>
`iron-a11y-announcer` is a singleton element that is intended to add a11y
to features that require on-demand announcement from screen readers. In
order to make use of the announcer, it is best to request its availability
in the announcing element.
Note: announcements are only audible if you have a screen reader enabled.
See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-a11y-announcer),
[Demo](https://www.webcomponents.org/element/@polymer/iron-a11y-announcer/demo/demo/index.html)
## Usage
### Installation
```
npm install --save @polymer/iron-a11y-announcer
```
### In an html file
```html
```
### In a Polymer 3 element
```js
import {PolymerElement, html} from '@polymer/polymer';
import {IronA11yAnnouncer} from '@polymer/iron-a11y-announcer/iron-a11y-announcer.js';
class SampleElement extends PolymerElement {
static get template() {
return html`
`;
}
function attached() {
IronA11yAnnouncer.requestAvailability();
}
// After the `iron-a11y-announcer` has been made available, elements can
// make announces by firing bubbling `iron-announce` events.
// Note: announcements are only audible if you have a screen reader enabled.
function announce() {
IronA11yAnnouncer.instance.fire('iron-announce',
{text: 'Hello there!'}, {bubbles: true});
}
}
customElements.define('sample-element', SampleElement);
```
## Contributing
If you want to send a PR to this element, here are
the instructions for running the tests and demo locally:
### Installation
```sh
git clone https://github.com/PolymerElements/iron-a11y-announcer
cd iron-a11y-announcer
npm install
npm install -g polymer-cli
```
### Running the demo locally
```sh
polymer serve --npm
open http://127.0.0.1:/demo/
```
### Running the tests
```sh
polymer test --npm
```
## Known Issues
This element doesn't work on Firefox (it doesn't read anything in Voice Over), since
`aria-live` has been broken since the Quantum redesign (see the [MDN docs demo](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions))
-- we tested it on Firefox 60, but it doesn't look like a regression, so
it's probably broken on older versions as well.
---
_Source: https://npm.io/package/@polymer/iron-a11y-announcer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._