PolymerElements/iron-a11y-announcer

Name: iron-a11y-announcer

Owner: PolymerElements

Description: An element that helps with announcing text through screen readers.

Created: 2015-05-21 18:03:44.0

Updated: 2018-04-19 16:46:24.0

Pushed: 2018-05-23 02:26:16.0

Homepage:

Size: 82

Language: HTML

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Build status

Demo and API docs

<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:

mer({

: 'x-chatty',

tached: 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:

.fire('iron-announce', {
xt: 'This is an announcement!'
 bubbles: true });

Note: announcements are only audible if you have a screen reader enabled.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.