• Home
Name Date Size #Lines LOC

..--

demo/03-May-2024-9061

test/03-May-2024-8452

CONTRIBUTING.mdD03-May-20243.2 KiB7339

README.mdD03-May-20241.3 KiB5023

bower.jsonD03-May-20241 KiB3433

index.htmlD03-May-2024905 2913

iron-a11y-announcer.htmlD03-May-20243.3 KiB12665

README.md

1
2<!---
3
4This README is automatically generated from the comments in these files:
5iron-a11y-announcer.html
6
7Edit those files, and our readme bot will duplicate them over here!
8Edit this file, and the bot will squash your changes :)
9
10-->
11
12[![Build Status](https://travis-ci.org/PolymerElements/iron-a11y-announcer.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-a11y-announcer)
13
14_[Demo and API Docs](https://elements.polymer-project.org/elements/iron-a11y-announcer)_
15
16
17##&lt;iron-a11y-announcer&gt;
18
19
20`iron-a11y-announcer` is a singleton element that is intended to add a11y
21to features that require on-demand announcement from screen readers. In
22order to make use of the announcer, it is best to request its availability
23in the announcing element.
24
25Example:
26
27    Polymer({
28
29      is: 'x-chatty',
30
31      attached: function() {
32        // This will create the singleton element if it has not
33        // been created yet:
34        Polymer.IronA11yAnnouncer.requestAvailability();
35      }
36    });
37
38After the `iron-a11y-announcer` has been made available, elements can
39make announces by firing bubbling `iron-announce` events.
40
41Example:
42
43    this.fire('iron-announce', {
44      text: 'This is an announcement!'
45    }, { bubbles: true });
46
47Note: announcements are only audible if you have a screen reader enabled.
48
49
50