/
focus-trap.test.ts
437 lines (360 loc) · 11.8 KB
/
focus-trap.test.ts
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
import { defineComponent, ref, nextTick, onMounted, ComponentOptionsWithoutProps } from 'vue'
import { FocusTrap } from './focus-trap'
import { assertActiveElement, getByText } from '../../test-utils/accessibility-assertions'
import { suppressConsoleLogs } from '../../test-utils/suppress-console-logs'
import { createRenderTemplate, render } from '../../test-utils/vue-testing-library'
import { click, press, shift, Keys } from '../../test-utils/interactions'
import { html } from '../../test-utils/html'
jest.mock('../../hooks/use-id')
beforeAll(() => {
jest.spyOn(window, 'requestAnimationFrame').mockImplementation(setImmediate as any)
jest.spyOn(window, 'cancelAnimationFrame').mockImplementation(clearImmediate as any)
})
afterAll(() => jest.restoreAllMocks())
const renderTemplate = createRenderTemplate({
FocusTrap,
})
it('should focus the first focusable element inside the FocusTrap', async () => {
renderTemplate(
html`
<FocusTrap>
<button>Trigger</button>
</FocusTrap>
`
)
await new Promise<void>(nextTick)
assertActiveElement(getByText('Trigger'))
})
it('should focus the autoFocus element inside the FocusTrap if that exists', async () => {
renderTemplate({
template: html`
<FocusTrap>
<input id="a" type="text" />
<input id="b" type="text" ref="autofocus" />
<input id="c" type="text" />
</FocusTrap>
`,
setup() {
let autofocus = ref<HTMLElement | null>(null)
onMounted(() => {
autofocus.value?.focus?.()
})
return { autofocus }
},
})
await new Promise<void>(nextTick)
assertActiveElement(document.getElementById('b'))
})
it('should focus the initialFocus element inside the FocusTrap if that exists', async () => {
renderTemplate({
template: html`
<FocusTrap :initialFocus="initialFocusRef">
<input id="a" type="text" />
<input id="b" type="text" />
<input id="c" type="text" ref="initialFocusRef" />
</FocusTrap>
`,
setup() {
let initialFocusRef = ref(null)
return { initialFocusRef }
},
})
await new Promise<void>(nextTick)
assertActiveElement(document.getElementById('c'))
})
it('should focus the initialFocus element inside the FocusTrap even if another element has autoFocus', async () => {
renderTemplate({
template: html`
<FocusTrap :initialFocus="initialFocusRef">
<input id="a" type="text" />
<input id="b" type="text" autofocus />
<input id="c" type="text" ref="initialFocusRef" />
</FocusTrap>
`,
setup() {
let initialFocusRef = ref(null)
return { initialFocusRef }
},
})
await new Promise<void>(nextTick)
assertActiveElement(document.getElementById('c'))
})
it('should warn when there is no focusable element inside the FocusTrap', async () => {
expect.assertions(1)
let spy = jest.spyOn(console, 'warn').mockImplementation(jest.fn())
renderTemplate(
html`
<FocusTrap>
<span>Nothing to see here...</span>
</FocusTrap>
`
)
await new Promise<void>(nextTick)
expect(spy.mock.calls[0][0]).toBe('There are no focusable elements inside the <FocusTrap />')
spy.mockReset()
})
it(
'should not be possible to programmatically escape the focus trap',
suppressConsoleLogs(async () => {
renderTemplate({
template: html`
<div>
<input id="a" autofocus />
<FocusTrap>
<input id="b" />
<input id="c" />
<input id="d" />
</FocusTrap>
</div>
`,
})
await new Promise<void>(nextTick)
let [a, b, c, d] = Array.from(document.querySelectorAll('input'))
// Ensure that input-b is the active element
assertActiveElement(b)
// Tab to the next item
await press(Keys.Tab)
// Ensure that input-c is the active element
assertActiveElement(c)
// Try to move focus
a?.focus()
// Ensure that input-c is still the active element
assertActiveElement(c)
// Click on an element within the FocusTrap
await click(b)
// Ensure that input-b is the active element
assertActiveElement(b)
// Try to move focus again
a?.focus()
// Ensure that input-b is still the active element
assertActiveElement(b)
// Focus on an element within the FocusTrap
d?.focus()
// Ensure that input-d is the active element
assertActiveElement(d)
// Try to move focus again
a?.focus()
// Ensure that input-d is still the active element
assertActiveElement(d)
})
)
it('should restore the previously focused element, before entering the FocusTrap, after the FocusTrap unmounts', async () => {
renderTemplate({
template: html`
<div>
<input id="item-1" ref="autoFocusRef" />
<button id="item-2" @click="visible = true">Open modal</button>
<FocusTrap v-if="visible">
<button id="item-3" @click="visible = false">Close</button>
</FocusTrap>
</div>
`,
setup() {
let visible = ref(false)
let autoFocusRef = ref<HTMLElement | null>(null)
onMounted(() => {
autoFocusRef.value?.focus()
})
return { visible, autoFocusRef }
},
})
await new Promise<void>(nextTick)
// The input should have focus by default because of the autoFocus prop
assertActiveElement(document.getElementById('item-1'))
// Open the modal
await click(document.getElementById('item-2')) // This will also focus this button
// Ensure that the first item inside the focus trap is focused
assertActiveElement(document.getElementById('item-3'))
// Close the modal
await click(document.getElementById('item-3'))
// Ensure that we restored focus correctly
assertActiveElement(document.getElementById('item-2'))
})
it('should be possible to tab to the next focusable element within the focus trap', async () => {
renderTemplate(
html`
<div>
<button>Before</button>
<FocusTrap>
<button id="item-a">Item A</button>
<button id="item-b">Item B</button>
<button id="item-c">Item C</button>
</FocusTrap>
<button>After</button>
</div>
`
)
await new Promise<void>(nextTick)
// Item A should be focused because the FocusTrap will focus the first item
assertActiveElement(document.getElementById('item-a'))
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-b'))
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-c'))
// Loop around!
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-a'))
})
it('should be possible to shift+tab to the previous focusable element within the focus trap', async () => {
renderTemplate(
html`
<div>
<button>Before</button>
<FocusTrap>
<button id="item-a">Item A</button>
<button id="item-b">Item B</button>
<button id="item-c">Item C</button>
</FocusTrap>
<button>After</button>
</div>
`
)
// Item A should be focused because the FocusTrap will focus the first item
assertActiveElement(document.getElementById('item-a'))
// Previous (loop around!)
await press(shift(Keys.Tab))
assertActiveElement(document.getElementById('item-c'))
// Previous
await press(shift(Keys.Tab))
assertActiveElement(document.getElementById('item-b'))
// Previous
await press(shift(Keys.Tab))
assertActiveElement(document.getElementById('item-a'))
})
it('should skip the initial "hidden" elements within the focus trap', async () => {
renderTemplate(
html`
<div>
<button id="before">Before</button>
<FocusTrap>
<button id="item-a" style="display:none">Item A</button>
<button id="item-b" style="display:none">Item B</button>
<button id="item-c">Item C</button>
<button id="item-d">Item D</button>
</FocusTrap>
<button>After</button>
</div>
`
)
// Item C should be focused because the FocusTrap had to skip the first 2
assertActiveElement(document.getElementById('item-c'))
})
it('should be possible skip "hidden" elements within the focus trap', async () => {
renderTemplate(
html`
<div>
<button id="before">Before</button>
<FocusTrap>
<button id="item-a">Item A</button>
<button id="item-b">Item B</button>
<button id="item-c" style="display:none">Item C</button>
<button id="item-d">Item D</button>
</FocusTrap>
<button>After</button>
</div>
`
)
// Item A should be focused because the FocusTrap will focus the first item
assertActiveElement(document.getElementById('item-a'))
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-b'))
// Notice that we skipped item-c
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-d'))
// Loop around!
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-a'))
})
it('should be possible skip disabled elements within the focus trap', async () => {
renderTemplate(
html`
<div>
<button id="before">Before</button>
<FocusTrap>
<button id="item-a">Item A</button>
<button id="item-b">Item B</button>
<button id="item-c" disabled>Item C</button>
<button id="item-d">Item D</button>
</FocusTrap>
<button>After</button>
</div>
`
)
// Item A should be focused because the FocusTrap will focus the first item
assertActiveElement(document.getElementById('item-a'))
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-b'))
// Notice that we skipped item-c
// Next
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-d'))
// Loop around!
await press(Keys.Tab)
assertActiveElement(document.getElementById('item-a'))
})
it('should try to focus all focusable items in order (and fail)', async () => {
let spy = jest.spyOn(console, 'warn').mockImplementation(jest.fn())
let focusHandler = jest.fn()
renderTemplate({
template: html`
<div>
<button id="before">Before</button>
<FocusTrap>
<button id="item-a" @focus="handleFocus">Item A</button>
<button id="item-b" @focus="handleFocus">Item B</button>
<button id="item-c" @focus="handleFocus">Item C</button>
<button id="item-d" @focus="handleFocus">Item D</button>
</FocusTrap>
<button>After</button>
</div>
`,
setup() {
return {
handleFocus(e: Event) {
let target = e.target as HTMLElement
focusHandler(target.id)
getByText('After')?.focus()
},
}
},
})
expect(focusHandler.mock.calls).toEqual([['item-a'], ['item-b'], ['item-c'], ['item-d']])
expect(spy).toHaveBeenCalledWith('There are no focusable elements inside the <FocusTrap />')
spy.mockReset()
})
it('should end up at the last focusable element', async () => {
let spy = jest.spyOn(console, 'warn').mockImplementation(jest.fn())
let focusHandler = jest.fn()
renderTemplate({
template: html`
<div>
<button id="before">Before</button>
<FocusTrap>
<button id="item-a" @focus="handleFocus">Item A</button>
<button id="item-b" @focus="handleFocus">Item B</button>
<button id="item-c" @focus="handleFocus">Item C</button>
<button id="item-d">Item D</button>
</FocusTrap>
<button>After</button>
</div>
`,
setup() {
return {
handleFocus(e: Event) {
let target = e.target as HTMLElement
focusHandler(target.id)
getByText('After')?.focus()
},
}
},
})
expect(focusHandler.mock.calls).toEqual([['item-a'], ['item-b'], ['item-c']])
assertActiveElement(getByText('Item D'))
expect(spy).not.toHaveBeenCalled()
spy.mockReset()
})