/
index.tsx
957 lines (815 loc) · 28.7 KB
/
index.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
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
/**
* External dependencies
*/
import { render, screen, waitFor } from '@testing-library/react';
import { press, hover, click, sleep } from '@ariakit/test';
/**
* WordPress dependencies
*/
import { wordpress, category, media } from '@wordpress/icons';
/**
* Internal dependencies
*/
import TabPanel from '..';
const TABS = [
{
name: 'alpha',
title: 'Alpha',
className: 'alpha-class',
},
{
name: 'beta',
title: 'Beta',
className: 'beta-class',
},
{
name: 'gamma',
title: 'Gamma',
className: 'gamma-class',
},
];
const getSelectedTab = async () =>
await screen.findByRole( 'tab', { selected: true } );
let originalGetClientRects: () => DOMRectList;
describe.each( [
[ 'uncontrolled', TabPanel ],
// The controlled component tests will be added once we certify the
// uncontrolled component's behaviour on trunk.
// [ 'controlled', TabPanel ],
] )( 'TabPanel %s', ( ...modeAndComponent ) => {
const [ , Component ] = modeAndComponent;
beforeAll( () => {
originalGetClientRects = window.HTMLElement.prototype.getClientRects;
// Mocking `getClientRects()` is necessary to pass a check performed by
// the `focus.tabbable.find()` and by the `focus.focusable.find()` functions
// from the `@wordpress/dom` package.
// @ts-expect-error We're not trying to comply to the DOM spec, only mocking
window.HTMLElement.prototype.getClientRects = function () {
return [ 'trick-jsdom-into-having-size-for-element-rect' ];
};
} );
afterAll( () => {
window.HTMLElement.prototype.getClientRects = originalGetClientRects;
} );
describe( 'Accessibility and semantics', () => {
it( 'should use the correct aria attributes', async () => {
const panelRenderFunction = jest.fn();
render(
<Component tabs={ TABS } children={ panelRenderFunction } />
);
const tabList = screen.getByRole( 'tablist' );
const allTabs = screen.getAllByRole( 'tab' );
const selectedTabPanel = await screen.findByRole( 'tabpanel' );
expect( tabList ).toBeVisible();
expect( tabList ).toHaveAttribute(
'aria-orientation',
'horizontal'
);
expect( allTabs ).toHaveLength( TABS.length );
// The selected `tab` aria-controls the active `tabpanel`,
// which is `aria-labelledby` the selected `tab`.
expect( selectedTabPanel ).toBeVisible();
expect( allTabs[ 0 ] ).toHaveAttribute(
'aria-controls',
selectedTabPanel.getAttribute( 'id' )
);
expect( selectedTabPanel ).toHaveAttribute(
'aria-labelledby',
allTabs[ 0 ].getAttribute( 'id' )
);
} );
it( 'should display a tooltip when hovering tabs provided with an icon', async () => {
const panelRenderFunction = jest.fn();
const TABS_WITH_ICON = [
{ ...TABS[ 0 ], icon: wordpress },
{ ...TABS[ 1 ], icon: category },
{ ...TABS[ 2 ], icon: media },
];
render(
<Component
tabs={ TABS_WITH_ICON }
children={ panelRenderFunction }
/>
);
const allTabs = screen.getAllByRole( 'tab' );
for ( let i = 0; i < allTabs.length; i++ ) {
expect(
screen.queryByText( TABS_WITH_ICON[ i ].title )
).not.toBeInTheDocument();
await hover( allTabs[ i ] );
await waitFor( () =>
expect(
screen.getByText( TABS_WITH_ICON[ i ].title )
).toBeVisible()
);
// Trigger closing the tooltip
await click( document.body );
}
} );
it( 'should display a tooltip when moving the selection via the keyboard on tabs provided with an icon', async () => {
const mockOnSelect = jest.fn();
const panelRenderFunction = jest.fn();
const TABS_WITH_ICON = [
{ ...TABS[ 0 ], icon: wordpress },
{ ...TABS[ 1 ], icon: category },
{ ...TABS[ 2 ], icon: media },
];
render(
<Component
tabs={ TABS_WITH_ICON }
children={ panelRenderFunction }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).not.toHaveTextContent( 'Alpha' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
expect( await getSelectedTab() ).not.toHaveFocus();
// Tab to focus the tablist. Make sure alpha is focused, and that the
// corresponding tooltip is shown.
expect( screen.queryByText( 'Alpha' ) ).not.toBeInTheDocument();
await sleep();
await press.Tab();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( screen.getByText( 'Alpha' ) ).toBeInTheDocument();
expect( await getSelectedTab() ).toHaveFocus();
// Move selection with arrow keys. Make sure beta is focused, and that
// the corresponding tooltip is shown.
expect( screen.queryByText( 'Beta' ) ).not.toBeInTheDocument();
await press.ArrowRight();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
expect( screen.getByText( 'Beta' ) ).toBeInTheDocument();
expect( await getSelectedTab() ).toHaveFocus();
// Move selection with arrow keys. Make sure gamma is focused, and that
// the corresponding tooltip is shown.
expect( screen.queryByText( 'Gamma' ) ).not.toBeInTheDocument();
await press.ArrowRight();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
expect( screen.getByText( 'Gamma' ) ).toBeInTheDocument();
expect( await getSelectedTab() ).toHaveFocus();
// Move selection with arrow keys. Make sure beta is focused, and that
// the corresponding tooltip is shown.
expect( screen.queryByText( 'Beta' ) ).not.toBeInTheDocument();
await press.ArrowLeft();
expect( mockOnSelect ).toHaveBeenCalledTimes( 4 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
expect( screen.getByText( 'Beta' ) ).toBeInTheDocument();
expect( await getSelectedTab() ).toHaveFocus();
} );
} );
describe( 'Without `initialTabName`', () => {
it( 'should render first tab', async () => {
const panelRenderFunction = jest.fn();
render(
<Component tabs={ TABS } children={ panelRenderFunction } />
);
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect(
await screen.findByRole( 'tabpanel', { name: 'Alpha' } )
).toBeInTheDocument();
} );
it( 'should fall back to first enabled tab if the active tab is removed', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
rerender(
<Component
tabs={ TABS.slice( 1 ) /* remove alpha */ }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
} );
} );
describe( 'With `initialTabName`', () => {
it( 'should render the tab set by initialTabName prop', async () => {
render(
<Component
initialTabName="beta"
tabs={ TABS }
children={ () => undefined }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
} );
it( 'should not select a tab when `initialTabName` does not match any known tab', () => {
render(
<Component
initialTabName="does-not-exist"
tabs={ TABS }
children={ () => undefined }
/>
);
// No tab should be selected i.e. it doesn't fall back to first tab.
expect(
screen.queryByRole( 'tab', { selected: true } )
).not.toBeInTheDocument();
// No tabpanel should be rendered either
expect( screen.queryByRole( 'tabpanel' ) ).not.toBeInTheDocument();
} );
it( 'should not change tabs when initialTabName is changed', async () => {
const { rerender } = render(
<Component
initialTabName="beta"
tabs={ TABS }
children={ () => undefined }
/>
);
rerender(
<Component
initialTabName="alpha"
tabs={ TABS }
children={ () => undefined }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
} );
it( 'should fall back to the tab associated to `initialTabName` if the currently active tab is removed', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
initialTabName="gamma"
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
await click( screen.getByRole( 'tab', { name: 'Alpha' } ) );
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
rerender(
<Component
initialTabName="gamma"
tabs={ TABS.slice( 1 ) } // Remove alpha
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
} );
it( 'should have no active tabs when the tab associated to `initialTabName` is removed while being the active tab', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
initialTabName="gamma"
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
rerender(
<Component
initialTabName="gamma"
tabs={ TABS.slice( 0, 2 ) } // Remove gamma
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( screen.getAllByRole( 'tab' ) ).toHaveLength( 2 );
expect(
screen.queryByRole( 'tab', { selected: true } )
).not.toBeInTheDocument();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
} );
it( 'waits for the tab with the `initialTabName` to be present in the `tabs` array before selecting it', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
initialTabName="delta"
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// There should be no selected tab yet.
expect(
screen.queryByRole( 'tab', { selected: true } )
).not.toBeInTheDocument();
rerender(
<Component
initialTabName="delta"
tabs={ [
{
name: 'delta',
title: 'Delta',
className: 'delta-class',
},
...TABS,
] }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Delta' );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'delta' );
} );
} );
describe( 'Disabled Tab', () => {
it( 'should disable the tab when `disabled` is `true`', async () => {
const mockOnSelect = jest.fn();
render(
<Component
tabs={ [
...TABS,
{
name: 'delta',
title: 'Delta',
className: 'delta-class',
disabled: true,
},
] }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect(
screen.getByRole( 'tab', { name: 'Delta' } )
).toHaveAttribute( 'aria-disabled', 'true' );
// onSelect gets called on the initial render.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// onSelect should not be called since the disabled tab is
// highlighted, but not selected.
await press.ArrowLeft();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
} );
it( 'should select first enabled tab when the initial tab is disabled', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
// Disable alpha
tabs={ TABS.map( ( tab ) => {
if ( tab.name !== 'alpha' ) {
return tab;
}
return { ...tab, disabled: true };
} ) }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// As alpha (first tab) is disabled,
// the first enabled tab should be gamma.
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
// Re-enable all tabs
rerender(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// Even if the initial tab becomes enabled again, the selected tab doesn't
// change.
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
} );
it( 'should select first enabled tab when the tab associated to `initialTabName` is disabled', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
tabs={ TABS.map( ( tab ) => {
if ( tab.name === 'gamma' ) {
return tab;
}
return { ...tab, disabled: true };
} ) }
initialTabName="beta"
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// As alpha (first tab), and beta (the initial tab), are both
// disabled the first enabled tab should be gamma.
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
// Re-enable all tabs
rerender(
<Component
tabs={ TABS }
initialTabName="beta"
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// Even if the initial tab becomes enabled again, the selected tab doesn't
// change.
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
} );
it( 'should select the first enabled tab when the selected tab becomes disabled', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
rerender(
<Component
tabs={ TABS.map( ( tab ) => {
if ( tab.name === 'alpha' ) {
return { ...tab, disabled: true };
}
return tab;
} ) }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
rerender(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
} );
it( 'should select the first enabled tab when the tab associated to `initialTabName` becomes disabled while being the active tab', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
initialTabName="gamma"
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
rerender(
<Component
initialTabName="gamma"
tabs={ [
TABS[ 0 ],
TABS[ 1 ],
{ ...TABS[ 2 ], disabled: true },
] } // Disable gamma
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
rerender(
<Component
initialTabName="gamma"
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
} );
} );
describe( 'Tab Activation', () => {
it( 'defaults to automatic tab activation (pointer clicks)', async () => {
const panelRenderFunction = jest.fn();
const mockOnSelect = jest.fn();
render(
<Component
tabs={ TABS }
children={ panelRenderFunction }
onSelect={ mockOnSelect }
/>
);
// Alpha is the initially selected tab
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect(
await screen.findByRole( 'tabpanel', { name: 'Alpha' } )
).toBeInTheDocument();
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
// Click on Beta, make sure beta is the selected tab
await click( screen.getByRole( 'tab', { name: 'Beta' } ) );
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect(
screen.getByRole( 'tabpanel', { name: 'Beta' } )
).toBeInTheDocument();
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
// Click on Alpha, make sure beta is the selected tab
await click( screen.getByRole( 'tab', { name: 'Alpha' } ) );
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect(
screen.getByRole( 'tabpanel', { name: 'Alpha' } )
).toBeInTheDocument();
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
} );
it( 'defaults to automatic tab activation (arrow keys)', async () => {
const mockOnSelect = jest.fn();
render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// onSelect gets called on the initial render.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Tab to focus the tablist. Make sure alpha is focused.
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).not.toHaveFocus();
await sleep();
await press.Tab();
expect( await getSelectedTab() ).toHaveFocus();
// Navigate forward with arrow keys and make sure the Beta tab is
// selected automatically.
await press.ArrowRight();
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
// Navigate backwards with arrow keys. Make sure alpha is
// selected automatically.
await press.ArrowLeft();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
} );
it( 'wraps around the last/first tab when using arrow keys', async () => {
const mockOnSelect = jest.fn();
render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// onSelect gets called on the initial render.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Tab to focus the tablist. Make sure Alpha is focused.
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).not.toHaveFocus();
await sleep();
await press.Tab();
expect( await getSelectedTab() ).toHaveFocus();
// Navigate backwards with arrow keys and make sure that the Gamma tab
// (the last tab) is selected automatically.
await press.ArrowLeft();
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
// Navigate forward with arrow keys. Make sure alpha (the first tab) is
// selected automatically.
await press.ArrowRight();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
} );
it( 'should not move tab selection when pressing the up/down arrow keys, unless the orientation is changed to `vertical`', async () => {
const mockOnSelect = jest.fn();
const { rerender } = render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// onSelect gets called on the initial render.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Tab to focus the tablist. Make sure alpha is focused.
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).not.toHaveFocus();
await sleep();
await press.Tab();
expect( await getSelectedTab() ).toHaveFocus();
// Press the arrow up key, nothing happens.
await press.ArrowUp();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
// Press the arrow down key, nothing happens
await press.ArrowDown();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
// Change orientation to `vertical`. When the orientation is vertical,
// left/right arrow keys are replaced by up/down arrow keys.
rerender(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
orientation="vertical"
/>
);
expect( screen.getByRole( 'tablist' ) ).toHaveAttribute(
'aria-orientation',
'vertical'
);
// Make sure alpha is still focused.
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
// Navigate forward with arrow keys and make sure the Beta tab is
// selected automatically.
await press.ArrowDown();
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
// Navigate backwards with arrow keys. Make sure alpha is
// selected automatically.
await press.ArrowUp();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
// Navigate backwards with arrow keys. Make sure alpha is
// selected automatically.
await press.ArrowUp();
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 4 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
// Navigate backwards with arrow keys. Make sure alpha is
// selected automatically.
await press.ArrowDown();
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 5 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
} );
it( 'should move focus on a tab even if disabled with arrow key, but not with pointer clicks', async () => {
const mockOnSelect = jest.fn();
render(
<Component
tabs={ [
...TABS,
{
name: 'delta',
title: 'Delta',
className: 'delta-class',
disabled: true,
},
] }
children={ () => undefined }
onSelect={ mockOnSelect }
/>
);
// onSelect gets called on the initial render.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Tab to focus the tablist. Make sure Alpha is focused.
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).not.toHaveFocus();
await sleep();
await press.Tab();
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Press the right arrow key three times. Since the delta tab is disabled:
// - it won't be selected. The gamma tab will be selected instead, since
// it was the tab that was last selected before delta. Therefore, the
// `mockOnSelect` function gets called only twice (and not three times)
// - it will receive focus, when using arrow keys
await press.ArrowRight();
await press.ArrowRight();
await press.ArrowRight();
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect(
screen.getByRole( 'tab', { name: 'Delta' } )
).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
// Navigate backwards with arrow keys. The gamma tab receives focus.
// The `mockOnSelect` callback doesn't fire, since the gamma tab was
// already selected.
await press.ArrowLeft();
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
// Click on the disabled tab. Compared to using arrow keys to move the
// focus, disabled tabs ignore pointer clicks — and therefore, they don't
// receive focus, nor they cause the `mockOnSelect` function to fire.
await click( screen.getByRole( 'tab', { name: 'Delta' } ) );
expect( await getSelectedTab() ).toHaveTextContent( 'Gamma' );
expect( await getSelectedTab() ).toHaveFocus();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
} );
it( 'should not focus the next tab when the Tab key is pressed', async () => {
render( <Component tabs={ TABS } children={ () => undefined } /> );
// Tab should initially focus the first tab in the tablist, which
// is Alpha.
await sleep();
await press.Tab();
expect(
await screen.findByRole( 'tab', { name: 'Alpha' } )
).toHaveFocus();
// Because all other tabs should have `tabindex=-1`, pressing Tab
// should NOT move the focus to the next tab, which is Beta.
await sleep();
await press.Tab();
expect(
await screen.findByRole( 'tab', { name: 'Beta' } )
).not.toHaveFocus();
} );
it( 'switches to manual tab activation when the `selectOnMove` prop is set to `false`', async () => {
const mockOnSelect = jest.fn();
render(
<Component
tabs={ TABS }
children={ () => undefined }
onSelect={ mockOnSelect }
selectOnMove={ false }
/>
);
// onSelect gets called on the initial render with the default
// selected tab.
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
// Click on Alpha and make sure it is selected.
// onSelect shouldn't fire since the selected tab didn't change.
await click( screen.getByRole( 'tab', { name: 'Alpha' } ) );
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'alpha' );
// Navigate forward with arrow keys. Make sure Beta is focused, but
// that the tab selection happens only when pressing the spacebar
// or enter key.
await press.ArrowRight();
expect( mockOnSelect ).toHaveBeenCalledTimes( 1 );
expect(
await screen.findByRole( 'tab', { name: 'Beta' } )
).toHaveFocus();
await press.Enter();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'beta' );
// Navigate forward with arrow keys. Make sure Gamma (last tab) is
// focused, but that tab selection happens only when pressing the
// spacebar or enter key.
await press.ArrowRight();
expect( mockOnSelect ).toHaveBeenCalledTimes( 2 );
expect(
screen.getByRole( 'tab', { name: 'Gamma' } )
).toHaveFocus();
await press.Space();
expect( mockOnSelect ).toHaveBeenCalledTimes( 3 );
expect( mockOnSelect ).toHaveBeenLastCalledWith( 'gamma' );
} );
} );
describe( 'Tab Attributes', () => {
it( "should apply the tab's `className` to the tab button", async () => {
render( <Component tabs={ TABS } children={ () => undefined } /> );
expect(
await screen.findByRole( 'tab', { name: 'Alpha' } )
).toHaveClass( 'alpha-class' );
expect( screen.getByRole( 'tab', { name: 'Beta' } ) ).toHaveClass(
'beta-class'
);
expect( screen.getByRole( 'tab', { name: 'Gamma' } ) ).toHaveClass(
'gamma-class'
);
} );
it( 'should apply the `activeClass` to the selected tab', async () => {
const activeClass = 'my-active-tab';
render(
<Component
activeClass={ activeClass }
tabs={ TABS }
children={ () => undefined }
/>
);
// Make sure that only the selected tab has the active class
expect( await getSelectedTab() ).toHaveTextContent( 'Alpha' );
expect( await getSelectedTab() ).toHaveClass( activeClass );
screen
.getAllByRole( 'tab', { selected: false } )
.forEach( ( unselectedTab ) => {
expect( unselectedTab ).not.toHaveClass( activeClass );
} );
// Click the 'Beta' tab
await click( screen.getByRole( 'tab', { name: 'Beta' } ) );
// Make sure that only the selected tab has the active class
expect( await getSelectedTab() ).toHaveTextContent( 'Beta' );
expect( await getSelectedTab() ).toHaveClass( activeClass );
screen
.getAllByRole( 'tab', { selected: false } )
.forEach( ( unselectedTab ) => {
expect( unselectedTab ).not.toHaveClass( activeClass );
} );
} );
} );
} );