blob: 8b997a307709eb20512bcb4c2dfa1b5a48023bd1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
<!---
This README is automatically generated from the comments in these files:
iron-a11y-announcer.html
Edit those files, and our readme bot will duplicate them over here!
Edit this file, and the bot will squash your changes :)
The bot does some handling of markdown. Please file a bug if it does the wrong
thing! https://github.com/PolymerLabs/tedium/issues
-->
[](https://travis-ci.org/PolymerElements/iron-a11y-announcer)
_[Demo and API docs](https://elements.polymer-project.org/elements/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.
Example:
```javascript
Polymer({
is: 'x-chatty',
attached: function() {
// This will create the singleton element if it has not
// been created yet:
Polymer.IronA11yAnnouncer.requestAvailability();
}
});
```
After the `iron-a11y-announcer` has been made available, elements can
make announces by firing bubbling `iron-announce` events.
Example:
```javascript
this.fire('iron-announce', {
text: 'This is an announcement!'
}, { bubbles: true });
```
Note: announcements are only audible if you have a screen reader enabled.
|
