aboutsummaryrefslogtreecommitdiff
path: root/catapult/third_party/polymer/components/iron-a11y-keys-behavior/test/basic-test.html
blob: d6947acae59a2ff5a8421263a7256ee36bd10c05 (plain)
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
<!doctype html>
<!--
@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
-->
<html>
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, minimum-scale=1.0, initial-scale=1.0, user-scalable=yes">
  <title>iron-a11y-keys</title>

  <script src="../../webcomponentsjs/webcomponents-lite.js"></script>
  <script src="../../web-component-tester/browser.js"></script>
  <script src="../../iron-test-helpers/mock-interactions.js"></script>

  <link rel="import" href="../../polymer/polymer.html">
  <link rel="import" href="../iron-a11y-keys-behavior.html">
</head>
<body>
  <test-fixture id="BasicKeys">
    <template>
      <x-a11y-basic-keys></x-a11y-basic-keys>
    </template>
  </test-fixture>

  <test-fixture id="NonPropagatingKeys">
    <template>
      <x-a11y-basic-keys stop-keyboard-event-propagation></x-a11y-basic-keys>
    </template>
  </test-fixture>

  <test-fixture id="ComboKeys">
    <template>
      <x-a11y-combo-keys></x-a11y-combo-keys>
    </template>
  </test-fixture>

  <test-fixture id="AlternativeEventKeys">
    <template>
      <x-a11y-alternate-event-keys></x-a11y-alternate-event-keys>
    </template>
  </test-fixture>

  <test-fixture id="BehaviorKeys">
    <template>
      <x-a11y-behavior-keys></x-a11y-behavior-keys>
    </template>
  </test-fixture>

  <test-fixture id="PreventKeys">
    <template>
      <x-a11y-prevent-keys></x-a11y-prevent-keys>
    </template>
  </test-fixture>

  <script>
suite('Polymer.IronA11yKeysBehavior', function() {
  var keys;

  suiteSetup(function() {
    var KeysTestBehavior = [Polymer.IronA11yKeysBehavior, {
      properties: {
        keyCount: {
          type: Number,
          value: 0
        }
      },

      _keyHandler: function(event) {
        this.keyCount++;
        this.lastEvent = event;
      },

      // Same as _keyHandler, used to distinguish who's called before who.
      _keyHandler2: function(event) {
        this.keyCount++;
        this.lastEvent = event;
      },

      _preventDefaultHandler: function(event) {
        event.preventDefault();
        this.keyCount++;
        this.lastEvent = event;
      }
    }];

    Polymer({
      is: 'x-a11y-basic-keys',

      behaviors: [
        KeysTestBehavior
      ],

      keyBindings: {
        'space': '_keyHandler',
        '@': '_keyHandler',
        'esc': '_keyHandler'
      }
    });

    Polymer({
      is: 'x-a11y-combo-keys',

      behaviors: [
        KeysTestBehavior
      ],

      keyBindings: {
        'enter': '_keyHandler2',
        'ctrl+shift+a shift+enter': '_keyHandler'
      }
    });

    Polymer({
      is: 'x-a11y-alternate-event-keys',

      behaviors: [
        KeysTestBehavior
      ],

      keyBindings: {
        'space:keyup': '_keyHandler'
      }
    });

    var XA11yBehavior = {
      keyBindings: {
        'enter': '_keyHandler'
      }
    };

    Polymer({
      is: 'x-a11y-behavior-keys',

      behaviors: [
        KeysTestBehavior,
        XA11yBehavior
      ],

      keyBindings: {
        'enter': '_keyHandler'
      }
    });

    Polymer({
      is: 'x-a11y-prevent-keys',

      behaviors: [
        KeysTestBehavior,
        XA11yBehavior
      ],

      keyBindings: {
        'space a': '_keyHandler',
        'enter shift+a': '_preventDefaultHandler'
      }
    });
  });

  suite('basic keys', function() {
    setup(function() {
      keys = fixture('BasicKeys');
    });

    test('trigger the handler when the specified key is pressed', function() {
      MockInteractions.pressSpace(keys);

      expect(keys.keyCount).to.be.equal(1);
    });

    test('keyEventTarget can be null, and disables listeners', function() {
      keys.keyEventTarget = null;
      MockInteractions.pressSpace(keys);

      expect(keys.keyCount).to.be.equal(0);
    });

    test('trigger the handler when the specified key is pressed together with a modifier', function() {
      var event = new CustomEvent('keydown');
      event.ctrlKey = true;
      event.keyCode = event.code = 32;
      keys.dispatchEvent(event);
      expect(keys.keyCount).to.be.equal(1);
    });

    test('handles special character @', function() {
      MockInteractions.pressAndReleaseKeyOn(keys, undefined, [], '@');

      expect(keys.keyCount).to.be.equal(1);
    });

    test('handles variations of Esc key', function() {
      MockInteractions.pressAndReleaseKeyOn(keys, undefined, [], 'Esc');
      expect(keys.keyCount).to.be.equal(1);

      MockInteractions.pressAndReleaseKeyOn(keys, undefined, [], 'Escape');
      expect(keys.keyCount).to.be.equal(2);

      MockInteractions.pressAndReleaseKeyOn(keys, 27, [], '');
      expect(keys.keyCount).to.be.equal(3);
    });

    test('do not trigger the handler for non-specified keys', function() {
      MockInteractions.pressEnter(keys);

      expect(keys.keyCount).to.be.equal(0);
    });

    test('can have bindings added imperatively', function() {
      keys.addOwnKeyBinding('enter', '_keyHandler');

      MockInteractions.pressEnter(keys);
      expect(keys.keyCount).to.be.equal(1);

      MockInteractions.pressSpace(keys);
      expect(keys.keyCount).to.be.equal(2);
    });

    test('can remove imperatively added bindings', function() {
      keys.addOwnKeyBinding('enter', '_keyHandler');
      keys.removeOwnKeyBindings();

      MockInteractions.pressEnter(keys);
      expect(keys.keyCount).to.be.equal(0);

      MockInteractions.pressSpace(keys);
      expect(keys.keyCount).to.be.equal(1);
    });

    test('allows propagation beyond the key combo handler', function() {
      var keySpy = sinon.spy();
      document.addEventListener('keydown', keySpy);

      MockInteractions.pressEnter(keys);

      expect(keySpy.callCount).to.be.equal(1);
    });

    suite('edge cases', function() {
      test('knows that `spacebar` is the same as `space`', function() {
        var event = new CustomEvent('keydown');
        event.key = 'spacebar';
        expect(keys.keyboardEventMatchesKeys(event, 'space')).to.be.equal(true);
      });

      test('handles `+`', function() {
        var event = new CustomEvent('keydown');
        event.key = '+';
        expect(keys.keyboardEventMatchesKeys(event, '+')).to.be.equal(true);
      });

      test('handles `:`', function() {
        var event = new CustomEvent('keydown');
        event.key = ':';
        expect(keys.keyboardEventMatchesKeys(event, ':')).to.be.equal(true);
      });

      test('handles ` ` (space)', function() {
        var event = new CustomEvent('keydown');
        event.key = ' ';
        expect(keys.keyboardEventMatchesKeys(event, 'space')).to.be.equal(true);
      });
    });

    suite('matching keyboard events to keys', function() {
      test('can be done imperatively', function() {
        var event = new CustomEvent('keydown');
        event.keyCode = 65;
        expect(keys.keyboardEventMatchesKeys(event, 'a')).to.be.equal(true);
      });

      test('can be done with a provided keyboardEvent', function() {
        var event;
        MockInteractions.pressSpace(keys);
        event = keys.lastEvent;

        expect(event.detail.keyboardEvent).to.be.okay;
        expect(keys.keyboardEventMatchesKeys(event, 'space')).to.be.equal(true);
      });

      test('can handle variations in arrow key names', function() {
        var event = new CustomEvent('keydown');
        event.key = 'up';
        expect(keys.keyboardEventMatchesKeys(event, 'up')).to.be.equal(true);
        event.key = 'ArrowUp';
        expect(keys.keyboardEventMatchesKeys(event, 'up')).to.be.equal(true);
      });
    });

    suite('matching keyboard events to top row and number pad digit keys', function() {
      test('top row can be done imperatively', function() {
        var event = new CustomEvent('keydown');
        event.keyCode = 49;
        expect(keys.keyboardEventMatchesKeys(event, '1')).to.be.equal(true);
      });

      test('number pad digits can be done imperatively', function() {
        var event = new CustomEvent('keydown');
        event.keyCode = 97;
        expect(keys.keyboardEventMatchesKeys(event, '1')).to.be.equal(true);
      });
    });
  });

  suite('combo keys', function() {
    setup(function() {
      keys = fixture('ComboKeys');
    });

    test('trigger the handler when the combo is pressed', function() {
      var event = new CustomEvent('keydown');

      event.ctrlKey = true;
      event.shiftKey = true;
      event.keyCode = event.code = 65;

      keys.dispatchEvent(event);

      expect(keys.keyCount).to.be.equal(1);
    });

    test('check if KeyBoardEvent.key is alpha-numberic', function() {
      var event = new CustomEvent('keydown');

      event.ctrlKey = true;
      event.shiftKey = true;
      event.key = 'A';

      keys.dispatchEvent(event);

      expect(keys.keyCount).to.be.equal(1);
    });

    test('trigger also bindings without modifiers', function() {
      var event = new CustomEvent('keydown');
      // Combo `shift+enter`.
      event.shiftKey = true;
      event.keyCode = event.code = 13;
      keys.dispatchEvent(event);
      expect(keys.keyCount).to.be.equal(2);
    });

    test('give precendence to combos with modifiers', function() {
      var enterSpy = sinon.spy(keys, '_keyHandler2');
      var shiftEnterSpy = sinon.spy(keys, '_keyHandler');
      var event = new CustomEvent('keydown');
      // Combo `shift+enter`.
      event.shiftKey = true;
      event.keyCode = event.code = 13;
      keys.dispatchEvent(event);
      expect(enterSpy.called).to.be.true;
      expect(shiftEnterSpy.called).to.be.true;
      expect(enterSpy.calledAfter(shiftEnterSpy)).to.be.true;
    });

  });

  suite('alternative event keys', function() {
    setup(function() {
      keys = fixture('AlternativeEventKeys');
    });

    test('trigger on the specified alternative keyboard event', function() {
      MockInteractions.keyDownOn(keys, 32);

      expect(keys.keyCount).to.be.equal(0);

      MockInteractions.keyUpOn(keys, 32);

      expect(keys.keyCount).to.be.equal(1);
    });
  });

  suite('behavior keys', function() {
    setup(function() {
      keys = fixture('BehaviorKeys');
    });

    test('bindings in other behaviors are transitive', function() {
      MockInteractions.pressEnter(keys);
      expect(keys.keyCount).to.be.equal(2);
    });
  });

  suite('stopping propagation automatically', function() {
    setup(function() {
      keys = fixture('NonPropagatingKeys');
    });

    test('does not propagate key events beyond the combo handler', function() {
      var keySpy = sinon.spy();

      document.addEventListener('keydown', keySpy);

      MockInteractions.pressEnter(keys);

      expect(keySpy.callCount).to.be.equal(0);
    });
  });

  suite('prevent default behavior of event', function() {
    setup(function() {
      keys = fixture('PreventKeys');
    });

    test('`defaultPrevented` is correctly set', function() {
      MockInteractions.pressEnter(keys);
      expect(keys.lastEvent.defaultPrevented).to.be.equal(true);
    });

    test('only 1 handler is invoked', function() {
      var aSpy = sinon.spy(keys, '_keyHandler');
      var shiftASpy = sinon.spy(keys, '_preventDefaultHandler');
      var event = new CustomEvent('keydown', {
        cancelable: true
      });
      // Combo `shift+a`.
      event.shiftKey = true;
      event.keyCode = event.code = 65;
      keys.dispatchEvent(event);

      expect(keys.keyCount).to.be.equal(1);
      expect(shiftASpy.called).to.be.true;
      expect(aSpy.called).to.be.false;
    });
  });

  suite('remove key behavior with null target', function () {
    test('add and remove a iron-a11y-keys-behavior', function () {
      var element = document.createElement('x-a11y-basic-keys');
      element.keyEventTarget = null;
      document.body.appendChild(element);
      document.body.removeChild(element);
    });
  });

});
  </script>
</body>
</html>