iron-a11y-announcer
An element that helps with announcing text through screen readers.
<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, Demo
Usage
Installation
npm install --save @polymer/iron-a11y-announcer
In an html file
<html>
<head>
<script type="module">
import {IronA11yAnnouncer} from '@polymer/iron-a11y-announcer/iron-a11y-announcer.js';
// Initialize the announcer.
IronA11yAnnouncer.requestAvailability();
// Note: announcements are only audible if you have a screen reader enabled.
IronA11yAnnouncer.instance.fire('iron-announce',
{text: 'Hello there!'}, {bubbles: true});
</script>
</head>
</html>
In a Polymer 3 element
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`
<button on-click="announce">Announce</button>
`;
}
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
git clone https://github.com/PolymerElements/iron-a11y-announcer
cd iron-a11y-announcer
npm install
npm install -g polymer-cli
Running the demo locally
polymer serve --npm
open http://127.0.0.1:<port>/demo/
Running the tests
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)
-- we tested it on Firefox 60, but it doesn't look like a regression, so
it's probably broken on older versions as well.
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- @polymer/polymer#^3.0.0
- Released
- 2018-11-12
- Maturity
- IMPORTED
- License
- BSD 3-clause "New" or "Revised" License
Compatibility
- Framework
- Polymer 3.0+
- Polymer 2.0+ in 2.1.0
- Polymer 1.0+ in 1.0.6
- Browser
- Browser Independent
iron-a11y-announcer - Vaadin Add-on Directory
An element that helps with announcing text through screen readers.
View on GitHub
License
iron-a11y-announcer version 0.9.0
### Dependencies
* polymer#polymer/polymer#^0.9.0
iron-a11y-announcer version 1.0.0
### Dependencies
* polymer#polymer/polymer#^1.0.0
iron-a11y-announcer version 1.0.1
### Dependencies
* polymer#polymer/polymer#^1.0.0
iron-a11y-announcer version 1.0.2
### Dependencies
* polymer#polymer/polymer#^1.0.0
iron-a11y-announcer version 1.0.3
### Dependencies
* polymer#polymer/polymer#^1.0.0
iron-a11y-announcer version 1.0.4
### Dependencies
* polymer#polymer/polymer#^1.0.0
iron-a11y-announcer version 0.0.1
### Dependencies
* @polymer/polymer#^1.2.5-npm-test.2
iron-a11y-announcer version 0.0.3
### Dependencies
* @polymer/polymer#^1.2.5-npm-test.2
iron-a11y-announcer version 1.0.5
### Dependencies
* polymer#polymer/polymer#^1.1.0
iron-a11y-announcer version 1.0.6
### Dependencies
* polymer#polymer/polymer#^1.1.0
iron-a11y-announcer version 2.0.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
iron-a11y-announcer version 3.0.0-pre.1
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
iron-a11y-announcer version 3.0.0-pre.2
### Dependencies
* @polymer/polymer#^3.0.0-pre.1
iron-a11y-announcer version 3.0.0-pre.3
### Dependencies
* @polymer/polymer#^3.0.0-pre.3
iron-a11y-announcer version 3.0.0-pre.4
### Dependencies
* @polymer/polymer#^3.0.0-pre.4
iron-a11y-announcer version 3.0.0-pre.6
### Dependencies
* @polymer/polymer#^3.0.0-pre.6
iron-a11y-announcer version 3.0.0-pre.7
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
iron-a11y-announcer version 3.0.0-pre.8
### Dependencies
* @polymer/polymer#^3.0.0-pre.7
iron-a11y-announcer version 2.1.0
### Dependencies
* polymer#Polymer/polymer#1.9 - 2
iron-a11y-announcer version 3.0.0-pre.10
### Dependencies
* @polymer/polymer#^3.0.0-pre.10
iron-a11y-announcer version 3.0.0-pre.11
### Dependencies
* @polymer/polymer#^3.0.0-pre.10
iron-a11y-announcer version 3.0.0-pre.12
### Dependencies
* @polymer/polymer#3.0.0-pre.12
iron-a11y-announcer version 3.0.0-pre.13
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
iron-a11y-announcer version 3.0.0-pre.14
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
iron-a11y-announcer version 3.0.0-pre.15
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
iron-a11y-announcer version 3.0.0-pre.16
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
iron-a11y-announcer version 3.0.0-pre.17
### Dependencies
* @polymer/polymer#^3.0.0-pre.13
iron-a11y-announcer version 3.0.0-pre.18
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.19
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.20
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.21
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.22
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.23
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.24
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.25
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0-pre.26
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.0
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.1
### Dependencies
* @polymer/polymer#^3.0.0
iron-a11y-announcer version 3.0.2
### Dependencies
* @polymer/polymer#^3.0.0