Index: third_party/polymer/v0_8/components/iron-a11y-announcer/README.md |
diff --git a/third_party/polymer/v0_8/components/iron-a11y-announcer/README.md b/third_party/polymer/v0_8/components/iron-a11y-announcer/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..5988d8c0a5b48169b6a4e0ed7910c1716bcb4614 |
--- /dev/null |
+++ b/third_party/polymer/v0_8/components/iron-a11y-announcer/README.md |
@@ -0,0 +1,29 @@ |
+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: |
+ |
+ Polymer({ |
+ is: 'x-chatty', |
+ attached: function() { |
+ // This will create the singlton 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: |
+ |
+ this.fire('iron-announce', { |
+ text: 'This is an announcement!' |
+ }, { bubbles: true }); |
+ |
+Note: announcements are only audible if you have a screen reader enabled. |