Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | - | - | ||||
.github/ | 23-Nov-2023 | - | 34 | 14 | ||
demo/ | 23-Nov-2023 | - | 100 | 61 | ||
test/ | 23-Nov-2023 | - | 82 | 51 | ||
.bower.json | D | 23-Nov-2023 | 1.4 KiB | 43 | 43 | |
.gitignore | D | 23-Nov-2023 | 17 | 2 | 1 | |
.travis.yml | D | 23-Nov-2023 | 1.8 KiB | 25 | 24 | |
CONTRIBUTING.md | D | 23-Nov-2023 | 3.4 KiB | 78 | 39 | |
README.md | D | 23-Nov-2023 | 1.4 KiB | 56 | 27 | |
bower.json | D | 23-Nov-2023 | 1,007 | 34 | 33 | |
index.html | D | 23-Nov-2023 | 905 | 29 | 13 | |
iron-a11y-announcer.html | D | 23-Nov-2023 | 3.1 KiB | 123 | 66 |
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 10The bot does some handling of markdown. Please file a bug if it does the wrong 11thing! https://github.com/PolymerLabs/tedium/issues 12 13--> 14 15[![Build status](https://travis-ci.org/PolymerElements/iron-a11y-announcer.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-a11y-announcer) 16 17_[Demo and API docs](https://elements.polymer-project.org/elements/iron-a11y-announcer)_ 18 19 20##<iron-a11y-announcer> 21 22`iron-a11y-announcer` is a singleton element that is intended to add a11y 23to features that require on-demand announcement from screen readers. In 24order to make use of the announcer, it is best to request its availability 25in the announcing element. 26 27Example: 28 29```javascript 30Polymer({ 31 32 is: 'x-chatty', 33 34 attached: function() { 35 // This will create the singleton element if it has not 36 // been created yet: 37 Polymer.IronA11yAnnouncer.requestAvailability(); 38 } 39}); 40``` 41 42After the `iron-a11y-announcer` has been made available, elements can 43make announces by firing bubbling `iron-announce` events. 44 45Example: 46 47```javascript 48this.fire('iron-announce', { 49 text: 'This is an announcement!' 50}, { bubbles: true }); 51``` 52 53Note: announcements are only audible if you have a screen reader enabled. 54 55 56