-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
/
Unstable_TrapFocus.test.js
377 lines (307 loc) · 10.4 KB
/
Unstable_TrapFocus.test.js
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
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { useFakeTimers } from 'sinon';
import { expect } from 'chai';
import { act, createClientRender, screen } from 'test/utils';
import TrapFocus from '@material-ui/unstyled/Unstable_TrapFocus';
import Portal from '@material-ui/unstyled/Portal';
describe('<TrapFocus />', () => {
const render = createClientRender();
let initialFocus = null;
beforeEach(() => {
initialFocus = document.createElement('button');
initialFocus.tabIndex = 0;
document.body.appendChild(initialFocus);
initialFocus.focus();
});
afterEach(() => {
document.body.removeChild(initialFocus);
});
it('should return focus to the root', () => {
const { getByTestId } = render(
<TrapFocus open>
<div tabIndex={-1} data-testid="root">
<input autoFocus data-testid="auto-focus" />
</div>
</TrapFocus>,
);
expect(getByTestId('auto-focus')).toHaveFocus();
initialFocus.focus();
expect(getByTestId('root')).toHaveFocus();
});
it('should not return focus to the children when disableEnforceFocus is true', () => {
const { getByTestId } = render(
<TrapFocus open disableEnforceFocus>
<div tabIndex={-1}>
<input autoFocus data-testid="auto-focus" />
</div>
</TrapFocus>,
);
expect(getByTestId('auto-focus')).toHaveFocus();
initialFocus.focus();
expect(initialFocus).toHaveFocus();
});
it('should focus first focusable child in portal', () => {
const { getByTestId } = render(
<TrapFocus open>
<div tabIndex={-1}>
<Portal>
<input autoFocus data-testid="auto-focus" />
</Portal>
</div>
</TrapFocus>,
);
expect(getByTestId('auto-focus')).toHaveFocus();
});
it('should warn if the root content is not focusable', () => {
const UnfocusableDialog = React.forwardRef((_, ref) => <div ref={ref} />);
expect(() => {
render(
<TrapFocus open>
<UnfocusableDialog />
</TrapFocus>,
);
}).toErrorDev('Material-UI: The modal content node does not accept focus');
});
it('should not attempt to focus nonexistent children', () => {
const EmptyDialog = React.forwardRef(() => null);
render(
<TrapFocus open>
<EmptyDialog />
</TrapFocus>,
);
});
it('should focus rootRef if no tabbable children are rendered', () => {
render(
<TrapFocus open>
<div tabIndex={-1} data-testid="root">
<div>Title</div>
</div>
</TrapFocus>,
);
expect(screen.getByTestId('root')).toHaveFocus();
});
it('does not steal focus from a portaled element if any prop but open changes', () => {
function Test(props) {
return (
<TrapFocus disableAutoFocus open {...props}>
<div data-testid="focus-root" tabIndex={-1}>
{ReactDOM.createPortal(<input data-testid="portal-input" />, document.body)}
</div>
</TrapFocus>
);
}
const { setProps } = render(<Test />);
const portaledTextbox = screen.getByTestId('portal-input');
portaledTextbox.focus();
// sanity check
expect(portaledTextbox).toHaveFocus();
setProps({ disableAutoFocus: false });
expect(portaledTextbox).toHaveFocus();
setProps({ disableEnforceFocus: true });
expect(portaledTextbox).toHaveFocus();
setProps({ disableRestoreFocus: true });
expect(portaledTextbox).toHaveFocus();
// same behavior, just referential equality changes
setProps({ isEnabled: () => true });
expect(portaledTextbox).toHaveFocus();
});
it('undesired: lazy root does not get autofocus', () => {
let mountDeferredComponent;
const DeferredComponent = React.forwardRef(function DeferredComponent(props, ref) {
const [mounted, setMounted] = React.useReducer(() => true, false);
mountDeferredComponent = setMounted;
if (mounted) {
return <div ref={ref} {...props} />;
}
return null;
});
render(
<TrapFocus open>
<DeferredComponent data-testid="deferred-component" />
</TrapFocus>,
);
expect(initialFocus).toHaveFocus();
act(() => {
mountDeferredComponent();
});
// desired
// expect(screen.getByTestId('deferred-component')).toHaveFocus();
// undesired
expect(initialFocus).toHaveFocus();
});
it('does not bounce focus around due to sync focus-restore + focus-contain', () => {
const eventLog = [];
function Test(props) {
return (
<div onBlur={() => eventLog.push('blur')}>
<TrapFocus open {...props}>
<div data-testid="root" tabIndex={-1}>
<input data-testid="focus-input" />
</div>
</TrapFocus>
</div>
);
}
const { setProps } = render(<Test />);
// same behavior, just referential equality changes
setProps({ isEnabled: () => true });
expect(screen.getByTestId('root')).toHaveFocus();
expect(eventLog).to.deep.equal([]);
});
it('does not focus if isEnabled returns false', () => {
function Test(props) {
return (
<div>
<input />
<TrapFocus open {...props}>
<div tabIndex={-1} data-testid="root" />
</TrapFocus>
</div>
);
}
const { setProps, getByRole } = render(<Test />);
expect(screen.getByTestId('root')).toHaveFocus();
getByRole('textbox').focus();
expect(getByRole('textbox')).not.toHaveFocus();
setProps({ isEnabled: () => false });
getByRole('textbox').focus();
expect(getByRole('textbox')).toHaveFocus();
});
it('restores focus when closed', () => {
function Test(props) {
return (
<TrapFocus open {...props}>
<div data-testid="focus-root" tabIndex={-1}>
<input />
</div>
</TrapFocus>
);
}
const { setProps } = render(<Test />);
setProps({ open: false });
expect(initialFocus).toHaveFocus();
});
it('undesired: enabling restore-focus logic when closing has no effect', () => {
function Test(props) {
return (
<TrapFocus open disableRestoreFocus {...props}>
<div data-testid="root" tabIndex={-1}>
<input data-testid="focus-input" />
</div>
</TrapFocus>
);
}
const { setProps } = render(<Test />);
setProps({ open: false, disableRestoreFocus: false });
// undesired: should be expect(initialFocus).toHaveFocus();
expect(screen.getByTestId('root')).toHaveFocus();
});
it('undesired: setting `disableRestoreFocus` to false before closing has no effect', () => {
function Test(props) {
return (
<TrapFocus open disableRestoreFocus {...props}>
<div data-testid="root" tabIndex={-1}>
<input data-testid="focus-input" />
</div>
</TrapFocus>
);
}
const { setProps } = render(<Test />);
setProps({ disableRestoreFocus: false });
setProps({ open: false });
// undesired: should be expect(initialFocus).toHaveFocus();
expect(screen.getByTestId('root')).toHaveFocus();
});
describe('interval', () => {
let clock;
beforeEach(() => {
clock = useFakeTimers();
});
afterEach(() => {
clock.restore();
});
it('contains the focus if the active element is removed', () => {
function WithRemovableElement({ hideButton = false }) {
return (
<TrapFocus open>
<div tabIndex={-1} data-testid="root">
{!hideButton && (
<button type="button" data-testid="hide-button">
I am going to disappear
</button>
)}
</div>
</TrapFocus>
);
}
const { setProps } = render(<WithRemovableElement />);
expect(screen.getByTestId('root')).toHaveFocus();
screen.getByTestId('hide-button').focus();
expect(screen.getByTestId('hide-button')).toHaveFocus();
setProps({ hideButton: true });
expect(screen.getByTestId('root')).not.toHaveFocus();
clock.tick(500); // wait for the interval check to kick in.
expect(screen.getByTestId('root')).toHaveFocus();
});
describe('prop: disableAutoFocus', () => {
it('should not trap', () => {
const { getByRole } = render(
<div>
<input />
<TrapFocus open disableAutoFocus>
<div tabIndex={-1} data-testid="root" />
</TrapFocus>
</div>,
);
clock.tick(500); // trigger an interval call
expect(initialFocus).toHaveFocus();
getByRole('textbox').focus(); // trigger a focus event
expect(getByRole('textbox')).toHaveFocus();
});
it('should trap once the focus moves inside', () => {
render(
<div>
<input data-testid="outside-input" />
<TrapFocus open disableAutoFocus>
<div tabIndex={-1} data-testid="root">
<button type="buton" data-testid="focus-input" />
</div>
</TrapFocus>
</div>,
);
expect(initialFocus).toHaveFocus();
screen.getByTestId('outside-input').focus();
expect(screen.getByTestId('outside-input')).toHaveFocus();
// the trap activates
screen.getByTestId('focus-input').focus();
expect(screen.getByTestId('focus-input')).toHaveFocus();
// the trap prevent to escape
screen.getByTestId('outside-input').focus();
expect(screen.getByTestId('root')).toHaveFocus();
});
it('should restore the focus', () => {
const Test = (props) => (
<div>
<input data-testid="outside-input" />
<TrapFocus open disableAutoFocus {...props}>
<div tabIndex={-1} data-testid="root">
<input data-testid="focus-input" />
</div>
</TrapFocus>
</div>
);
const { setProps } = render(<Test />);
// set the expected focus restore location
screen.getByTestId('outside-input').focus();
expect(screen.getByTestId('outside-input')).toHaveFocus();
// the trap activates
screen.getByTestId('root').focus();
expect(screen.getByTestId('root')).toHaveFocus();
// restore the focus to the first element before triggering the trap
setProps({ open: false });
expect(screen.getByTestId('outside-input')).toHaveFocus();
});
});
});
});