Blame view

bower_components/iron-a11y-announcer/iron-a11y-announcer.html 3.28 KB
73bcce88   luigser   COMPONENTS
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  <!--
  @license
  Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
  This code may only be used under the BSD style license found at http://polymer.github.io/LICENSE.txt
  The complete set of authors may be found at http://polymer.github.io/AUTHORS.txt
  The complete set of contributors may be found at http://polymer.github.io/CONTRIBUTORS.txt
  Code distributed by Google as part of the polymer project is also
  subject to an additional IP rights grant found at http://polymer.github.io/PATENTS.txt
  -->
  
  <link rel="import" href="../polymer/polymer.html">
  
  <!--
  `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.
  
  @group Iron Elements
  @demo demo/index.html
  -->
  
  <dom-module id="iron-a11y-announcer">
    <style>
      :host {
        display: inline-block;
        position: fixed;
        clip: rect(0px,0px,0px,0px);
      }
    </style>
  
    <template>
      <span aria-live$="[[mode]]">[[_text]]</span>
    </template>
  
    <script>
  
      (function() {
        'use strict';
  
        Polymer.IronA11yAnnouncer = Polymer({
          is: 'iron-a11y-announcer',
  
          properties: {
  
            /**
             * The value of mode is used to set the `aria-live` attribute
             * for the element that will be announced. Valid values are: `off`,
             * `polite` and `assertive`.
             */
            mode: {
              type: String,
              value: 'polite'
            },
  
            _text: {
              type: String,
              value: ''
            }
          },
  
          created: function() {
            if (!Polymer.IronA11yAnnouncer.instance) {
              Polymer.IronA11yAnnouncer.instance = this;
            }
  
            document.body.addEventListener('iron-announce', this._onIronAnnounce.bind(this));
          },
  
          /**
           * Cause a text string to be announced by screen readers.
           *
           * @param {string} text The text that should be announced.
           */
          announce: function(text) {
            this._text = '';
            this.async(function() {
              this._text = text;
            }, 100);
          },
  
          _onIronAnnounce: function(event) {
            if (event.detail && event.detail.text) {
              this.announce(event.detail.text);
            }
          }
        });
  
        Polymer.IronA11yAnnouncer.instance = null;
  
        Polymer.IronA11yAnnouncer.requestAvailability = function() {
          if (!Polymer.IronA11yAnnouncer.instance) {
            Polymer.IronA11yAnnouncer.instance = document.createElement('iron-a11y-announcer');
          }
  
          document.body.appendChild(Polymer.IronA11yAnnouncer.instance);
        };
      })();
  
    </script>
  </dom-module>