/
index.test.tsx
485 lines (429 loc) · 14.3 KB
/
index.test.tsx
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
import * as React from 'react';
import { render, fireEvent, waitFor } from '@testing-library/react';
import { Modal } from '../src';
describe('modal', () => {
describe('overlay', () => {
it('should call onClose when click on the overlay', () => {
const onClose = jest.fn();
const { getByTestId } = render(
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
);
fireEvent.click(getByTestId('modal-container'));
expect(onClose).toHaveBeenCalledTimes(1);
});
it('should disable the handler when closeOnOverlayClick is false', () => {
const onClose = jest.fn();
const { getByTestId } = render(
<Modal open onClose={onClose} closeOnOverlayClick={false}>
<div>modal content</div>
</Modal>
);
fireEvent.click(getByTestId('modal-container'));
expect(onClose).not.toHaveBeenCalled();
});
it('should ignore the overlay click if the event does not come from the overlay', () => {
const onClose = jest.fn();
const { getByTestId } = render(
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
);
fireEvent.click(getByTestId('modal'));
expect(onClose).not.toHaveBeenCalled();
});
});
describe('key events', () => {
it('an invalid event should not call onClose', () => {
const onClose = jest.fn();
const { container } = render(
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
);
fireEvent.keyDown(container, { key: 'Enter', keyCode: 13 });
expect(onClose).not.toHaveBeenCalled();
});
it('should not call onClose when closeOnEsc is false', () => {
const onClose = jest.fn();
const { container } = render(
<Modal open onClose={onClose} closeOnEsc={false}>
<div>modal content</div>
</Modal>
);
fireEvent.keyDown(container, { keyCode: 27 });
expect(onClose).not.toHaveBeenCalled();
});
it('should call onClose when pressing esc key', () => {
const onClose = jest.fn();
const { container } = render(
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
);
fireEvent.keyDown(container, { keyCode: 27 });
expect(onClose).toHaveBeenCalledTimes(1);
});
it('should call onClose of last modal only when pressing esc key when multiple modals are opened', () => {
const onClose = jest.fn();
const onClose2 = jest.fn();
const { container } = render(
<>
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
<Modal open onClose={onClose2}>
<div>modal content</div>
</Modal>
</>
);
fireEvent.keyDown(container, { keyCode: 27 });
expect(onClose).not.toHaveBeenCalled();
expect(onClose2).toHaveBeenCalledTimes(1);
});
});
describe('body scroll', () => {
it('should not block the scroll when modal is rendered closed', () => {
render(
<Modal open={false} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('');
});
it('should block the scroll when modal is rendered open', () => {
render(
<Modal open={true} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('hidden');
});
it('should block scroll when prop open change to true', () => {
const { rerender } = render(
<Modal open={false} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('');
rerender(
<Modal open={true} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('hidden');
});
it('should unblock scroll when prop open change to false', async () => {
const { rerender, queryByTestId, getByTestId } = render(
<Modal open={true} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('hidden');
rerender(
<Modal open={false} onClose={() => null} animationDuration={0}>
<div>modal content</div>
</Modal>
);
// Simulate the browser animation end
fireEvent.animationEnd(getByTestId('modal'));
await waitFor(
() => {
expect(queryByTestId('modal')).not.toBeInTheDocument();
},
{ timeout: 1 }
);
expect(document.body.style.overflow).toBe('');
});
it('should unblock scroll when unmounted directly', async () => {
const { unmount } = render(
<Modal open={true} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('hidden');
unmount();
expect(document.body.style.overflow).toBe('');
});
it('should unblock scroll when multiple modals are opened and then closed', async () => {
const { rerender, getAllByTestId, queryByText } = render(
<React.Fragment>
<Modal open onClose={() => null}>
<div>first modal</div>
</Modal>
<Modal open onClose={() => null}>
<div>second modal</div>
</Modal>
</React.Fragment>
);
expect(document.body.style.overflow).toBe('hidden');
// We close one modal, the scroll should be locked
rerender(
<React.Fragment>
<Modal open onClose={() => null}>
<div>first modal</div>
</Modal>
<Modal open={false} onClose={() => null}>
<div>second modal</div>
</Modal>
</React.Fragment>
);
fireEvent.animationEnd(getAllByTestId('modal')[1]);
await waitFor(
() => {
expect(queryByText(/second modal/)).not.toBeInTheDocument();
},
{ timeout: 1 }
);
expect(document.body.style.overflow).toBe('hidden');
// We close the second modal, the scroll should be unlocked
rerender(
<React.Fragment>
<Modal open={false} onClose={() => null}>
<div>first modal</div>
</Modal>
<Modal open={false} onClose={() => null}>
<div>second modal</div>
</Modal>
</React.Fragment>
);
fireEvent.animationEnd(getAllByTestId('modal')[0]);
await waitFor(
() => {
expect(queryByText(/first modal/)).not.toBeInTheDocument();
},
{ timeout: 1 }
);
expect(document.body.style.overflow).toBe('');
});
it('should unblock scroll when one modal is closed and the one still open has blockScroll set to false', async () => {
const { rerender, getAllByTestId, queryByText } = render(
<React.Fragment>
<Modal open blockScroll={false} onClose={() => null}>
<div>first modal</div>
</Modal>
<Modal open onClose={() => null}>
<div>second modal</div>
</Modal>
</React.Fragment>
);
expect(document.body.style.overflow).toBe('hidden');
// We close one modal, the scroll should be unlocked as remaining modal is not locking the scroll
rerender(
<React.Fragment>
<Modal open blockScroll={false} onClose={() => null}>
<div>first modal</div>
</Modal>
<Modal open={false} onClose={() => null}>
<div>second modal</div>
</Modal>
</React.Fragment>
);
fireEvent.animationEnd(getAllByTestId('modal')[1]);
await waitFor(
() => {
expect(queryByText(/second modal/)).not.toBeInTheDocument();
},
{ timeout: 1 }
);
expect(document.body.style.overflow).toBe('');
});
});
describe('closeIcon', () => {
it('should render the closeIcon by default', () => {
const { getByTestId } = render(
<Modal open onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(getByTestId('close-button')).toMatchSnapshot();
});
it('should hide closeIcon when showCloseIcon is false', () => {
const { queryByTestId } = render(
<Modal open onClose={() => null} showCloseIcon={false}>
<div>modal content</div>
</Modal>
);
expect(queryByTestId('close-button')).toBeNull();
});
it('should call onClose when clicking on the icon', () => {
const onClose = jest.fn();
const { getByTestId } = render(
<Modal open onClose={onClose}>
<div>modal content</div>
</Modal>
);
fireEvent.click(getByTestId('close-button'));
expect(onClose).toHaveBeenCalledTimes(1);
});
});
describe('render', () => {
it('should render null when then modal is not open', () => {
const { queryByText } = render(
<Modal open={false} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(queryByText(/modal content/)).toBeNull();
});
it('should render the content when modal is open', () => {
const { queryByText } = render(
<Modal open onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(queryByText(/modal content/)).toBeTruthy();
});
});
describe('lifecycle', () => {
it('should show modal when prop open change to true', () => {
const { queryByTestId, rerender } = render(
<Modal open={false} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(queryByTestId('modal')).toBeNull();
rerender(
<Modal open={true} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(queryByTestId('modal')).toBeTruthy();
});
it('should hide modal when prop open change to false', async () => {
const { getByTestId, queryByTestId, rerender } = render(
<Modal open={true} onClose={() => null} animationDuration={0.01}>
<div>modal content</div>
</Modal>
);
expect(queryByTestId('modal')).toBeTruthy();
rerender(
<Modal open={false} onClose={() => null} animationDuration={0.01}>
<div>modal content</div>
</Modal>
);
fireEvent.animationEnd(getByTestId('modal'));
expect(queryByTestId('modal')).toBeNull();
});
});
describe('prop: center', () => {
it('should not apply center class by default', async () => {
const { getByTestId } = render(
<Modal open onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(getByTestId('modal-container').classList.length).toBe(1);
expect(
getByTestId('modal-container').classList.contains(
'react-responsive-modal-containerCenter'
)
).toBeFalsy();
});
it('should apply center class to modal', async () => {
const { getByTestId } = render(
<Modal open onClose={() => null} center>
<div>modal content</div>
</Modal>
);
expect(getByTestId('modal-container').classList.length).toBe(2);
expect(
getByTestId('modal-container').classList.contains(
'react-responsive-modal-containerCenter'
)
).toBeTruthy();
});
});
describe('prop: closeIcon', () => {
it('should render custom icon instead of the default one', async () => {
const { queryByTestId, getByTestId } = render(
<Modal
open
onClose={() => null}
closeIcon={<div data-testid="custom-icon">custom icon</div>}
>
<div>modal content</div>
</Modal>
);
expect(queryByTestId('close-icon')).toBeNull();
expect(getByTestId('custom-icon')).toMatchSnapshot();
});
});
describe('prop: classNames', () => {
it('should apply custom classes to the modal', async () => {
const { getByTestId } = render(
<Modal
open
onClose={() => null}
classNames={{
overlay: 'custom-overlay',
modal: 'custom-modal',
closeButton: 'custom-closeButton',
closeIcon: 'custom-closeIcon',
}}
>
<div>modal content</div>
</Modal>
);
expect(
getByTestId('overlay').classList.contains('custom-overlay')
).toBeTruthy();
expect(
getByTestId('modal').classList.contains('custom-modal')
).toBeTruthy();
expect(
getByTestId('close-button').classList.contains('custom-closeButton')
).toBeTruthy();
expect(
getByTestId('close-icon').classList.contains('custom-closeIcon')
).toBeTruthy();
});
});
describe('prop: blockScroll', () => {
it('should not block the scroll when modal is opened and blockScroll is false', () => {
render(
<Modal open blockScroll={false} onClose={() => null}>
<div>modal content</div>
</Modal>
);
expect(document.body.style.overflow).toBe('');
});
});
describe('prop: onEscKeyDown', () => {
it('should be called when esc key is pressed', async () => {
const onEscKeyDown = jest.fn();
const { container } = render(
<Modal open onClose={() => null} onEscKeyDown={onEscKeyDown}>
<div>modal content</div>
</Modal>
);
fireEvent.keyDown(container, { keyCode: 27 });
expect(onEscKeyDown).toHaveBeenCalledTimes(1);
});
});
describe('prop: onOverlayClick', () => {
it('should be called when user click on overlay', async () => {
const onOverlayClick = jest.fn();
const { getByTestId } = render(
<Modal open onClose={() => null} onOverlayClick={onOverlayClick}>
<div>modal content</div>
</Modal>
);
fireEvent.click(getByTestId('modal-container'));
expect(onOverlayClick).toHaveBeenCalledTimes(1);
});
});
describe('prop: onAnimationEnd', () => {
it('should be called when the animation is finished', async () => {
const onAnimationEnd = jest.fn();
const { getByTestId } = render(
<Modal open onClose={() => null} onAnimationEnd={onAnimationEnd}>
<div>modal content</div>
</Modal>
);
fireEvent.animationEnd(getByTestId('modal'));
expect(onAnimationEnd).toHaveBeenCalledTimes(1);
});
});
});