@instructure/ui-selectable 10.11.1-snapshot-2 → 10.11.1-snapshot-3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1278 @@
1
+ /*
2
+ * The MIT License (MIT)
3
+ *
4
+ * Copyright (c) 2015 - present Instructure, Inc.
5
+ *
6
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ * of this software and associated documentation files (the "Software"), to deal
8
+ * in the Software without restriction, including without limitation the rights
9
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ * copies of the Software, and to permit persons to whom the Software is
11
+ * furnished to do so, subject to the following conditions:
12
+ *
13
+ * The above copyright notice and this permission notice shall be included in all
14
+ * copies or substantial portions of the Software.
15
+ *
16
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ * SOFTWARE.
23
+ */
24
+
25
+ import React from 'react'
26
+ import { render, screen, waitFor } from '@testing-library/react'
27
+ import { vi } from 'vitest'
28
+ import userEvent from '@testing-library/user-event'
29
+ import '@testing-library/jest-dom'
30
+
31
+ import { Selectable } from '../index'
32
+ import { SelectableRender } from '../props'
33
+
34
+ const defaultOptions = ['foo', 'bar', 'baz']
35
+
36
+ describe('<Selectable />', () => {
37
+ const getSelectable = (selectable: SelectableRender) => (
38
+ <span {...selectable.getRootProps()}>
39
+ <label {...selectable.getLabelProps()}>Selectable</label>
40
+ <input
41
+ type="text"
42
+ {...selectable.getTriggerProps()}
43
+ {...selectable.getInputProps()}
44
+ />
45
+ <ul {...selectable.getListProps()}>
46
+ {defaultOptions.map((opt) => (
47
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
48
+ {opt}
49
+ </li>
50
+ ))}
51
+ </ul>
52
+ </span>
53
+ )
54
+
55
+ it('should focus trigger when label is clicked', async () => {
56
+ render(
57
+ <Selectable>
58
+ {(selectable) => (
59
+ <span {...selectable.getRootProps()}>
60
+ <label {...selectable.getLabelProps()}>Selectable</label>
61
+ <input
62
+ type="text"
63
+ {...selectable.getTriggerProps()}
64
+ {...selectable.getInputProps()}
65
+ />
66
+ <ul {...selectable.getListProps()}>
67
+ {defaultOptions.map((opt) => (
68
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
69
+ {opt}
70
+ </li>
71
+ ))}
72
+ </ul>
73
+ </span>
74
+ )}
75
+ </Selectable>
76
+ )
77
+ const label = screen.getByText('Selectable')
78
+ const input = screen.getByRole('combobox')
79
+
80
+ expect(document.activeElement).not.toBe(input)
81
+
82
+ userEvent.click(label)
83
+
84
+ await waitFor(() => {
85
+ expect(document.activeElement).toBe(input)
86
+ })
87
+ })
88
+
89
+ it('should not blur trigger when label is clicked', async () => {
90
+ const onFocus = vi.fn()
91
+ const onBlur = vi.fn()
92
+
93
+ render(
94
+ <Selectable>
95
+ {(selectable) => (
96
+ <span {...selectable.getRootProps()}>
97
+ <label {...selectable.getLabelProps()}>Selectable</label>
98
+ <input
99
+ type="text"
100
+ {...selectable.getTriggerProps()}
101
+ {...selectable.getInputProps()}
102
+ onBlur={onBlur}
103
+ onFocus={onFocus}
104
+ />
105
+ <ul {...selectable.getListProps()}>
106
+ {defaultOptions.map((opt) => (
107
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
108
+ {opt}
109
+ </li>
110
+ ))}
111
+ </ul>
112
+ </span>
113
+ )}
114
+ </Selectable>
115
+ )
116
+ const label = screen.getByText('Selectable')
117
+ const input = screen.getByRole('combobox')
118
+
119
+ expect(document.activeElement).not.toBe(input)
120
+
121
+ userEvent.click(label)
122
+
123
+ await waitFor(() => {
124
+ expect(onFocus).toHaveBeenCalledTimes(1)
125
+ expect(onBlur).not.toHaveBeenCalled()
126
+ })
127
+ })
128
+
129
+ it('should not hide options when list is clicked', async () => {
130
+ const onClick = vi.fn()
131
+ const onMouseDown = vi.fn()
132
+ const onRequestHideOptions = vi.fn()
133
+
134
+ render(
135
+ <Selectable
136
+ isShowingOptions={true}
137
+ onRequestHideOptions={onRequestHideOptions}
138
+ >
139
+ {(selectable) => (
140
+ <span {...selectable.getRootProps()}>
141
+ <label {...selectable.getLabelProps()}>Selectable</label>
142
+ <input
143
+ type="text"
144
+ {...selectable.getTriggerProps()}
145
+ {...selectable.getInputProps()}
146
+ />
147
+ <ul {...selectable.getListProps({ onClick, onMouseDown })}>
148
+ {defaultOptions.map((opt) => (
149
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
150
+ {opt}
151
+ </li>
152
+ ))}
153
+ </ul>
154
+ </span>
155
+ )}
156
+ </Selectable>
157
+ )
158
+ const input = screen.getByRole('combobox')
159
+ const list = screen.getByRole('listbox')
160
+
161
+ input.focus()
162
+ userEvent.click(list)
163
+
164
+ await waitFor(() => {
165
+ expect(document.activeElement).toBe(input)
166
+ expect(onClick).toHaveBeenCalledTimes(1)
167
+ expect(onMouseDown).toHaveBeenCalledTimes(1)
168
+ expect(onRequestHideOptions).not.toHaveBeenCalled()
169
+ })
170
+ })
171
+
172
+ it('should not hide options when an option is clicked', async () => {
173
+ const onClick = vi.fn()
174
+ const onMouseDown = vi.fn()
175
+ const onRequestHideOptions = vi.fn()
176
+
177
+ render(
178
+ <Selectable
179
+ isShowingOptions={true}
180
+ onRequestHideOptions={onRequestHideOptions}
181
+ >
182
+ {(selectable) => (
183
+ <span {...selectable.getRootProps()}>
184
+ <label {...selectable.getLabelProps()}>Selectable</label>
185
+ <input
186
+ type="text"
187
+ {...selectable.getTriggerProps()}
188
+ {...selectable.getInputProps()}
189
+ />
190
+ <ul {...selectable.getListProps()}>
191
+ {defaultOptions.map((opt) => (
192
+ <li
193
+ key={opt}
194
+ {...selectable.getOptionProps({
195
+ id: opt,
196
+ onClick,
197
+ onMouseDown
198
+ })}
199
+ >
200
+ {opt}
201
+ </li>
202
+ ))}
203
+ </ul>
204
+ </span>
205
+ )}
206
+ </Selectable>
207
+ )
208
+ const input = screen.getByRole('combobox')
209
+ const option = screen.getByText('foo')
210
+
211
+ input.focus()
212
+ userEvent.click(option)
213
+
214
+ await waitFor(() => {
215
+ expect(document.activeElement).toBe(input)
216
+ expect(onClick).toHaveBeenCalledTimes(1)
217
+ expect(onMouseDown).toHaveBeenCalledTimes(1)
218
+ expect(onRequestHideOptions).not.toHaveBeenCalled()
219
+ })
220
+ })
221
+
222
+ it('should not prevent events on other children', async () => {
223
+ const onMouseDown = vi.fn()
224
+ const onClick = vi.fn()
225
+ const onKeyDown = vi.fn()
226
+
227
+ render(
228
+ <Selectable>
229
+ {(selectable) => (
230
+ <span {...selectable.getRootProps()}>
231
+ <label {...selectable.getLabelProps()}>Selectable</label>
232
+ <button
233
+ onMouseDown={onMouseDown}
234
+ onClick={onClick}
235
+ onKeyDown={onKeyDown}
236
+ >
237
+ Selected
238
+ </button>
239
+ <input
240
+ type="text"
241
+ {...selectable.getTriggerProps()}
242
+ {...selectable.getInputProps()}
243
+ />
244
+ <ul {...selectable.getListProps()}>
245
+ {defaultOptions.map((opt) => (
246
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
247
+ {opt}
248
+ </li>
249
+ ))}
250
+ </ul>
251
+ </span>
252
+ )}
253
+ </Selectable>
254
+ )
255
+ const button = screen.getByText('Selected')
256
+
257
+ userEvent.click(button)
258
+ await userEvent.type(button, '{enter}')
259
+
260
+ await waitFor(() => {
261
+ expect(onClick).toHaveBeenCalled()
262
+ expect(onMouseDown).toHaveBeenCalled()
263
+ expect(onKeyDown).toHaveBeenCalled()
264
+ })
265
+ })
266
+
267
+ describe('with callbacks', () => {
268
+ describe('should fire onRequestShowOptions', () => {
269
+ it('when label is clicked', async () => {
270
+ const onRequestShowOptions = vi.fn()
271
+
272
+ const { rerender } = render(
273
+ <Selectable
274
+ isShowingOptions={false}
275
+ onRequestShowOptions={onRequestShowOptions}
276
+ >
277
+ {(selectable) => getSelectable(selectable)}
278
+ </Selectable>
279
+ )
280
+ const label = screen.getByText('Selectable')
281
+
282
+ userEvent.click(label)
283
+
284
+ await waitFor(() => {
285
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
286
+ })
287
+
288
+ // Set isShowingOptions:
289
+ rerender(
290
+ <Selectable
291
+ isShowingOptions={true}
292
+ onRequestShowOptions={onRequestShowOptions}
293
+ >
294
+ {(selectable) => getSelectable(selectable)}
295
+ </Selectable>
296
+ )
297
+
298
+ userEvent.click(label)
299
+
300
+ await waitFor(() => {
301
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
302
+ })
303
+ })
304
+
305
+ it('when input is clicked', async () => {
306
+ const onRequestShowOptions = vi.fn()
307
+
308
+ const { rerender } = render(
309
+ <Selectable
310
+ isShowingOptions={false}
311
+ onRequestShowOptions={onRequestShowOptions}
312
+ >
313
+ {(selectable) => getSelectable(selectable)}
314
+ </Selectable>
315
+ )
316
+ const input = screen.getByRole('combobox')
317
+
318
+ userEvent.click(input)
319
+
320
+ await waitFor(() => {
321
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
322
+ })
323
+
324
+ rerender(
325
+ <Selectable
326
+ isShowingOptions={true}
327
+ onRequestShowOptions={onRequestShowOptions}
328
+ >
329
+ {(selectable) => getSelectable(selectable)}
330
+ </Selectable>
331
+ )
332
+
333
+ userEvent.click(input)
334
+
335
+ await waitFor(() => {
336
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
337
+ })
338
+ })
339
+
340
+ it('when up/down arrows are pressed', async () => {
341
+ const onRequestShowOptions = vi.fn()
342
+
343
+ render(
344
+ <Selectable
345
+ isShowingOptions={false}
346
+ onRequestShowOptions={onRequestShowOptions}
347
+ >
348
+ {(selectable) => getSelectable(selectable)}
349
+ </Selectable>
350
+ )
351
+ const input = screen.getByRole('combobox')
352
+
353
+ await userEvent.type(input, '{arrowdown}')
354
+ await waitFor(() => {
355
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
356
+ })
357
+
358
+ await userEvent.type(input, '{arrowup}')
359
+ await waitFor(() => {
360
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(2)
361
+ })
362
+ })
363
+
364
+ it('when space is pressed', async () => {
365
+ const onRequestShowOptions = vi.fn()
366
+
367
+ const { rerender } = render(
368
+ <Selectable onRequestShowOptions={onRequestShowOptions}>
369
+ {(selectable) => getSelectable(selectable)}
370
+ </Selectable>
371
+ )
372
+ const input = screen.getByRole('combobox')
373
+
374
+ await userEvent.type(input, '{space}')
375
+
376
+ rerender(
377
+ <Selectable
378
+ isShowingOptions={true}
379
+ onRequestShowOptions={onRequestShowOptions}
380
+ >
381
+ {(selectable) => getSelectable(selectable)}
382
+ </Selectable>
383
+ )
384
+
385
+ await userEvent.type(input, '{space}')
386
+ await waitFor(() => {
387
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
388
+ })
389
+ })
390
+ })
391
+
392
+ describe('should fire onRequestHideOptions', () => {
393
+ it('when label is clicked', async () => {
394
+ const onRequestHideOptions = vi.fn()
395
+
396
+ const { rerender } = render(
397
+ <Selectable
398
+ isShowingOptions={true}
399
+ onRequestHideOptions={onRequestHideOptions}
400
+ >
401
+ {(selectable) => getSelectable(selectable)}
402
+ </Selectable>
403
+ )
404
+ const label = screen.getByText('Selectable')
405
+
406
+ await userEvent.click(label)
407
+ await waitFor(() => {
408
+ expect(onRequestHideOptions).toHaveBeenCalledTimes(1)
409
+ })
410
+
411
+ rerender(
412
+ <Selectable
413
+ isShowingOptions={false}
414
+ onRequestHideOptions={onRequestHideOptions}
415
+ >
416
+ {(selectable) => getSelectable(selectable)}
417
+ </Selectable>
418
+ )
419
+
420
+ await userEvent.click(label)
421
+ await waitFor(() => {
422
+ expect(onRequestHideOptions).toHaveBeenCalledTimes(1)
423
+ })
424
+ })
425
+
426
+ it('when input is clicked', async () => {
427
+ const onRequestHideOptions = vi.fn()
428
+
429
+ const { rerender } = render(
430
+ <Selectable
431
+ isShowingOptions={true}
432
+ onRequestHideOptions={onRequestHideOptions}
433
+ >
434
+ {(selectable) => getSelectable(selectable)}
435
+ </Selectable>
436
+ )
437
+ const input = screen.getByRole('combobox')
438
+
439
+ await userEvent.click(input)
440
+ await waitFor(() => {
441
+ expect(onRequestHideOptions).toHaveBeenCalledTimes(1)
442
+ })
443
+
444
+ rerender(
445
+ <Selectable
446
+ isShowingOptions={false}
447
+ onRequestHideOptions={onRequestHideOptions}
448
+ >
449
+ {(selectable) => getSelectable(selectable)}
450
+ </Selectable>
451
+ )
452
+
453
+ await userEvent.click(input)
454
+ await waitFor(() => {
455
+ expect(onRequestHideOptions).toHaveBeenCalledTimes(1)
456
+ })
457
+ })
458
+ })
459
+ })
460
+
461
+ describe('getRootProps()', () => {
462
+ it('should provide prop getter for root element', async () => {
463
+ const renderSpy = vi.fn()
464
+
465
+ render(
466
+ <Selectable>
467
+ {(selectable) => {
468
+ renderSpy(selectable)
469
+ return null
470
+ }}
471
+ </Selectable>
472
+ )
473
+ const selectableProps = renderSpy.mock.calls[0][0]
474
+ expect(selectableProps.getRootProps).toBeDefined()
475
+ })
476
+
477
+ it('should allow custom props to pass through', async () => {
478
+ render(
479
+ <Selectable>
480
+ {(selectable) => (
481
+ <span
482
+ {...selectable.getRootProps({
483
+ 'data-custom-attr': true,
484
+ className: 'customClass',
485
+ style: { color: 'red' }
486
+ })}
487
+ >
488
+ <label {...selectable.getLabelProps()}>Selectable</label>
489
+ <input
490
+ type="text"
491
+ {...selectable.getTriggerProps()}
492
+ {...selectable.getInputProps()}
493
+ />
494
+ </span>
495
+ )}
496
+ </Selectable>
497
+ )
498
+ const root = screen.getByText('Selectable').closest('span')
499
+
500
+ expect(root).toHaveAttribute('data-custom-attr', 'true')
501
+ expect(root).toHaveClass('customClass')
502
+ expect(root).toHaveStyle('color: rgb(255, 0, 0)')
503
+ })
504
+
505
+ it('should allow supplemental onClick behavior', async () => {
506
+ const onClick = vi.fn()
507
+ const onRequestShowOptions = vi.fn()
508
+
509
+ render(
510
+ <Selectable onRequestShowOptions={onRequestShowOptions}>
511
+ {(selectable) => (
512
+ <span>
513
+ <input
514
+ type="text"
515
+ {...selectable.getTriggerProps({ onClick })}
516
+ {...selectable.getInputProps()}
517
+ />
518
+ </span>
519
+ )}
520
+ </Selectable>
521
+ )
522
+ const input = screen.getByRole('combobox')
523
+
524
+ await userEvent.click(input)
525
+ await waitFor(() => {
526
+ expect(onClick).toHaveBeenCalledTimes(1)
527
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
528
+ })
529
+ })
530
+ })
531
+
532
+ describe('getLabelProps()', () => {
533
+ it('should provide prop getter for label element', async () => {
534
+ const renderSpy = vi.fn()
535
+
536
+ render(
537
+ <Selectable>
538
+ {(selectable) => {
539
+ renderSpy(selectable)
540
+ return null
541
+ }}
542
+ </Selectable>
543
+ )
544
+
545
+ expect(renderSpy.mock.calls[0].length > 0).toBeTruthy()
546
+ })
547
+
548
+ it('should set htmlFor prop', async () => {
549
+ render(
550
+ <Selectable>
551
+ {(selectable) => (
552
+ <span>
553
+ <label {...selectable.getLabelProps()}>Selectable</label>
554
+ <input
555
+ type="text"
556
+ {...selectable.getTriggerProps()}
557
+ {...selectable.getInputProps()}
558
+ />
559
+ </span>
560
+ )}
561
+ </Selectable>
562
+ )
563
+ const label = screen.getByText('Selectable')
564
+ const input = screen.getByRole('combobox')
565
+
566
+ expect(label).toHaveAttribute('for', input.getAttribute('id'))
567
+ })
568
+
569
+ it('should set htmlFor prop with custom defined id', async () => {
570
+ const customId = 'CustomSelect'
571
+
572
+ render(
573
+ <Selectable id={customId}>
574
+ {(selectable) => (
575
+ <span>
576
+ <label {...selectable.getLabelProps()}>Selectable</label>
577
+ <input
578
+ type="text"
579
+ {...selectable.getTriggerProps()}
580
+ {...selectable.getInputProps()}
581
+ />
582
+ </span>
583
+ )}
584
+ </Selectable>
585
+ )
586
+ const label = screen.getByText('Selectable')
587
+ const input = screen.getByRole('combobox')
588
+
589
+ expect(input).toHaveAttribute('id', customId)
590
+ expect(label).toHaveAttribute('for', customId)
591
+ })
592
+
593
+ it('should allow custom props to pass through', async () => {
594
+ render(
595
+ <Selectable>
596
+ {(selectable) => (
597
+ <span>
598
+ <label
599
+ {...selectable.getLabelProps({
600
+ 'data-custom-attr': true,
601
+ className: 'customClass',
602
+ style: { color: 'red' }
603
+ })}
604
+ >
605
+ Selectable
606
+ </label>
607
+ <input
608
+ type="text"
609
+ {...selectable.getTriggerProps()}
610
+ {...selectable.getInputProps()}
611
+ />
612
+ </span>
613
+ )}
614
+ </Selectable>
615
+ )
616
+ const label = screen.getByText('Selectable')
617
+
618
+ expect(label).toHaveAttribute('data-custom-attr', 'true')
619
+ expect(label).toHaveClass('customClass')
620
+ expect(label).toHaveStyle({ color: 'rgb(255, 0, 0)' })
621
+ })
622
+ })
623
+
624
+ describe('getTriggerProps()', () => {
625
+ it('should provide prop getter for trigger element', async () => {
626
+ const renderSpy = vi.fn()
627
+
628
+ render(
629
+ <Selectable>
630
+ {(selectable) => {
631
+ renderSpy(selectable)
632
+ return null
633
+ }}
634
+ </Selectable>
635
+ )
636
+ expect(renderSpy.mock.calls[0][0].getTriggerProps).toBeDefined()
637
+ })
638
+
639
+ it('should set appropriate prop defaults', async () => {
640
+ const { container } = render(
641
+ <Selectable>
642
+ {(selectable) => (
643
+ <span>
644
+ <input type="text" {...selectable.getTriggerProps()} />
645
+ <span {...selectable.getDescriptionProps()}>description</span>
646
+ </span>
647
+ )}
648
+ </Selectable>
649
+ )
650
+
651
+ const input = container.querySelector('input')
652
+ const desc = screen.getByText('description')
653
+
654
+ expect(input).toHaveAttribute('aria-haspopup', 'listbox')
655
+ expect(input).toHaveAttribute('aria-describedby', desc.id)
656
+ expect(input).toHaveAttribute('id')
657
+ })
658
+
659
+ it('should set appropriate props based on isShowingOptions', async () => {
660
+ const { container, rerender } = render(
661
+ <Selectable isShowingOptions={false}>
662
+ {(selectable) => (
663
+ <span>
664
+ <input type="text" {...selectable.getTriggerProps()} />
665
+ <ul {...selectable.getListProps()}></ul>
666
+ </span>
667
+ )}
668
+ </Selectable>
669
+ )
670
+ const input = container.querySelector('input')
671
+ const list = screen.getByRole('listbox')
672
+
673
+ expect(input).toHaveAttribute('aria-expanded', 'false')
674
+ expect(input).not.toHaveAttribute('aria-controls')
675
+
676
+ // Set prop: isShowingOptions true
677
+ rerender(
678
+ <Selectable isShowingOptions={true}>
679
+ {(selectable) => (
680
+ <span>
681
+ <input type="text" {...selectable.getTriggerProps()} />
682
+ <ul {...selectable.getListProps()}></ul>
683
+ </span>
684
+ )}
685
+ </Selectable>
686
+ )
687
+
688
+ expect(input).toHaveAttribute('aria-expanded', 'true')
689
+ expect(input).toHaveAttribute('aria-controls', list.id)
690
+ })
691
+
692
+ it('should set appropriate props based on highlightedOptionId', async () => {
693
+ const { container, rerender } = render(
694
+ <Selectable isShowingOptions={true}>
695
+ {(selectable) => (
696
+ <span>
697
+ <input type="text" {...selectable.getTriggerProps()} />
698
+ <ul {...selectable.getListProps()}>
699
+ {defaultOptions.map((opt) => (
700
+ <li key={opt} {...selectable.getOptionProps({ id: opt })} />
701
+ ))}
702
+ </ul>
703
+ </span>
704
+ )}
705
+ </Selectable>
706
+ )
707
+ const input = container.querySelector('input')
708
+ const options = screen.getAllByRole('option')
709
+
710
+ expect(input).not.toHaveAttribute('aria-activedescendant')
711
+
712
+ // Set prop: highlightedOptionId
713
+ rerender(
714
+ <Selectable
715
+ isShowingOptions={true}
716
+ highlightedOptionId={defaultOptions[0]}
717
+ >
718
+ {(selectable) => (
719
+ <span>
720
+ <input type="text" {...selectable.getTriggerProps()} />
721
+ <ul {...selectable.getListProps()}>
722
+ {defaultOptions.map((opt) => (
723
+ <li key={opt} {...selectable.getOptionProps({ id: opt })} />
724
+ ))}
725
+ </ul>
726
+ </span>
727
+ )}
728
+ </Selectable>
729
+ )
730
+ expect(input).toHaveAttribute('aria-activedescendant', options[0].id)
731
+
732
+ // Set prop: highlightedOptionId
733
+ rerender(
734
+ <Selectable
735
+ isShowingOptions={true}
736
+ highlightedOptionId={defaultOptions[1]}
737
+ >
738
+ {(selectable) => (
739
+ <span>
740
+ <input type="text" {...selectable.getTriggerProps()} />
741
+ <ul {...selectable.getListProps()}>
742
+ {defaultOptions.map((opt) => (
743
+ <li key={opt} {...selectable.getOptionProps({ id: opt })} />
744
+ ))}
745
+ </ul>
746
+ </span>
747
+ )}
748
+ </Selectable>
749
+ )
750
+ expect(input).toHaveAttribute('aria-activedescendant', options[1].id)
751
+
752
+ // Set prop: isShowingOptions
753
+ rerender(
754
+ <Selectable
755
+ isShowingOptions={false}
756
+ highlightedOptionId={defaultOptions[1]}
757
+ >
758
+ {(selectable) => (
759
+ <span>
760
+ <input type="text" {...selectable.getTriggerProps()} />
761
+ <ul {...selectable.getListProps()}>
762
+ {defaultOptions.map((opt) => (
763
+ <li key={opt} {...selectable.getOptionProps({ id: opt })} />
764
+ ))}
765
+ </ul>
766
+ </span>
767
+ )}
768
+ </Selectable>
769
+ )
770
+ expect(input).not.toHaveAttribute('aria-activedescendant')
771
+ })
772
+
773
+ it('should allow custom props to pass through', async () => {
774
+ const { container } = render(
775
+ <Selectable>
776
+ {(selectable) => (
777
+ <span>
778
+ <input
779
+ type="text"
780
+ {...selectable.getTriggerProps({
781
+ 'data-custom-attr': true,
782
+ placeholder: 'Type to enter text',
783
+ className: 'customClass',
784
+ style: { color: 'red' }
785
+ })}
786
+ />
787
+ </span>
788
+ )}
789
+ </Selectable>
790
+ )
791
+ const input = container.querySelector('input')
792
+
793
+ expect(input).toHaveAttribute('data-custom-attr', 'true')
794
+ expect(input).toHaveAttribute('style', 'color: red;')
795
+ expect(input).toHaveAttribute('placeholder')
796
+ expect(input).toHaveClass('customClass')
797
+ })
798
+
799
+ it('should allow props to be overridden', async () => {
800
+ const { container } = render(
801
+ <Selectable>
802
+ {(selectable) => (
803
+ <span>
804
+ <input
805
+ type="text"
806
+ {...selectable.getTriggerProps({
807
+ 'aria-haspopup': 'menu',
808
+ 'aria-controls': 'customId'
809
+ })}
810
+ />
811
+ </span>
812
+ )}
813
+ </Selectable>
814
+ )
815
+ const input = container.querySelector('input')
816
+
817
+ expect(input).toHaveAttribute('aria-haspopup', 'menu')
818
+ expect(input).toHaveAttribute('aria-controls', 'customId')
819
+ })
820
+
821
+ it('should provide a ref to the text input', async () => {
822
+ const inputRef = vi.fn()
823
+
824
+ const { container } = render(
825
+ <Selectable>
826
+ {(selectable) => (
827
+ <span>
828
+ <input
829
+ type="text"
830
+ {...selectable.getTriggerProps({
831
+ ref: inputRef
832
+ })}
833
+ />
834
+ </span>
835
+ )}
836
+ </Selectable>
837
+ )
838
+ const input = container.querySelector('input')
839
+
840
+ expect(inputRef).toHaveBeenCalledWith(input)
841
+ })
842
+
843
+ it('should allow role and aria-autocomplete props to be overridden', async () => {
844
+ const { container } = render(
845
+ <Selectable>
846
+ {(selectable) => (
847
+ <span>
848
+ <input
849
+ type="text"
850
+ {...selectable.getTriggerProps({
851
+ role: 'textbox',
852
+ 'aria-autocomplete': 'list'
853
+ })}
854
+ />
855
+ </span>
856
+ )}
857
+ </Selectable>
858
+ )
859
+ const input = container.querySelector('input')
860
+
861
+ expect(input).toHaveAttribute('role', 'textbox')
862
+ expect(input).toHaveAttribute('aria-autocomplete', 'list')
863
+ })
864
+
865
+ it('should allow supplemental onClick behavior', async () => {
866
+ const onClick = vi.fn()
867
+
868
+ const onRequestShowOptions = vi.fn()
869
+
870
+ render(
871
+ <Selectable onRequestShowOptions={onRequestShowOptions}>
872
+ {(selectable) => (
873
+ <span {...selectable.getRootProps()}>
874
+ <input
875
+ type="text"
876
+ {...selectable.getTriggerProps({ onClick })}
877
+ {...selectable.getInputProps()}
878
+ />
879
+ </span>
880
+ )}
881
+ </Selectable>
882
+ )
883
+ const input = screen.getByRole('combobox')
884
+
885
+ await input.click()
886
+ expect(onClick).toHaveBeenCalledTimes(1)
887
+ expect(onRequestShowOptions).toHaveBeenCalledTimes(1)
888
+ })
889
+ })
890
+
891
+ describe('getInputProps()', () => {
892
+ it('should provide prop getter for trigger element', async () => {
893
+ const renderSpy = vi.fn()
894
+
895
+ render(
896
+ <Selectable>
897
+ {(selectable) => {
898
+ renderSpy(selectable)
899
+ return null
900
+ }}
901
+ </Selectable>
902
+ )
903
+ const args = renderSpy.mock.calls[0][0]
904
+
905
+ expect(args.getInputProps).toBeDefined()
906
+ })
907
+
908
+ it('should set appropriate prop defaults', async () => {
909
+ const { container } = render(
910
+ <Selectable>
911
+ {(selectable) => (
912
+ <span>
913
+ <input type="text" {...selectable.getInputProps()} />
914
+ </span>
915
+ )}
916
+ </Selectable>
917
+ )
918
+ const input = container.querySelector('input')
919
+
920
+ expect(input).toHaveAttribute('role', 'combobox')
921
+ expect(input).toHaveAttribute('aria-autocomplete', 'both')
922
+ expect(input).toHaveAttribute('autocomplete', 'off')
923
+ })
924
+
925
+ it('should set appropriate props when readOnly', async () => {
926
+ render(
927
+ <Selectable>
928
+ {(selectable) => (
929
+ <span>
930
+ <input
931
+ type="text"
932
+ {...selectable.getInputProps({ readOnly: true })}
933
+ />
934
+ </span>
935
+ )}
936
+ </Selectable>
937
+ )
938
+ const input = screen.getByRole('combobox')
939
+
940
+ expect(input).toHaveAttribute('aria-autocomplete', 'none')
941
+ expect(input).toHaveAttribute('readOnly')
942
+ expect(input).not.toHaveAttribute('disabled')
943
+ })
944
+
945
+ it('should allow props to be overridden', async () => {
946
+ const { container } = render(
947
+ <Selectable>
948
+ {(selectable) => (
949
+ <span>
950
+ <input
951
+ type="text"
952
+ {...selectable.getInputProps({
953
+ role: 'textbox',
954
+ 'aria-autocomplete': 'inline'
955
+ })}
956
+ />
957
+ </span>
958
+ )}
959
+ </Selectable>
960
+ )
961
+ const input = container.querySelector('input')
962
+
963
+ expect(input).toHaveAttribute('role', 'textbox')
964
+ expect(input).toHaveAttribute('aria-autocomplete', 'inline')
965
+ })
966
+
967
+ it('should allow custom props to pass through', async () => {
968
+ const { container } = render(
969
+ <Selectable>
970
+ {(selectable) => (
971
+ <span>
972
+ <input
973
+ type="text"
974
+ {...selectable.getInputProps({
975
+ 'data-custom-attr': true,
976
+ placeholder: 'Type to enter text',
977
+ className: 'customClass',
978
+ style: { color: 'red' }
979
+ })}
980
+ />
981
+ </span>
982
+ )}
983
+ </Selectable>
984
+ )
985
+ const input = container.querySelector('input')
986
+
987
+ expect(input).toHaveAttribute('data-custom-attr', 'true')
988
+ expect(input).toHaveAttribute('placeholder')
989
+ expect(input).toHaveClass('customClass')
990
+ expect(input).toHaveAttribute('style', 'color: red;')
991
+ })
992
+ })
993
+
994
+ describe('getListProps()', () => {
995
+ it('should provide prop getter for list element', async () => {
996
+ const renderSpy = vi.fn()
997
+
998
+ render(
999
+ <Selectable>
1000
+ {(selectable) => {
1001
+ renderSpy(selectable)
1002
+ return null
1003
+ }}
1004
+ </Selectable>
1005
+ )
1006
+ const args = renderSpy.mock.calls[0][0]
1007
+
1008
+ expect(args.getListProps).toBeDefined()
1009
+ })
1010
+
1011
+ it('should set appropriate prop defaults', async () => {
1012
+ const { container } = render(
1013
+ <Selectable isShowingOptions={true}>
1014
+ {(selectable) => (
1015
+ <span {...selectable.getRootProps()}>
1016
+ <input type="text" {...selectable.getTriggerProps()} />
1017
+ <ul {...selectable.getListProps()}></ul>
1018
+ </span>
1019
+ )}
1020
+ </Selectable>
1021
+ )
1022
+ const list = container.querySelector('ul')
1023
+
1024
+ expect(list).toHaveAttribute('id')
1025
+ expect(list).toHaveAttribute('role', 'listbox')
1026
+ })
1027
+
1028
+ it('should allow custom props to pass through', async () => {
1029
+ const { container } = render(
1030
+ <Selectable isShowingOptions={true}>
1031
+ {(selectable) => (
1032
+ <span {...selectable.getRootProps()}>
1033
+ <input type="text" {...selectable.getTriggerProps()} />
1034
+ <ul
1035
+ {...selectable.getListProps({
1036
+ 'data-custom-attr': true,
1037
+ className: 'customClass',
1038
+ style: { color: 'red' }
1039
+ })}
1040
+ ></ul>
1041
+ </span>
1042
+ )}
1043
+ </Selectable>
1044
+ )
1045
+ const list = container.querySelector('ul')
1046
+
1047
+ expect(list).toHaveAttribute('data-custom-attr', 'true')
1048
+ expect(list).toHaveClass('customClass')
1049
+ expect(list).toHaveAttribute('style', 'color: red;')
1050
+ })
1051
+ })
1052
+
1053
+ describe('getOptionProps()', () => {
1054
+ it('should provide prop getter for option element', async () => {
1055
+ const renderSpy = vi.fn()
1056
+
1057
+ render(
1058
+ <Selectable>
1059
+ {(selectable) => {
1060
+ renderSpy(selectable)
1061
+ return null
1062
+ }}
1063
+ </Selectable>
1064
+ )
1065
+ const args = renderSpy.mock.calls[0][0]
1066
+
1067
+ expect(args.getOptionProps).toBeDefined()
1068
+ })
1069
+
1070
+ it('should set appropriate prop defaults', async () => {
1071
+ render(
1072
+ <Selectable>
1073
+ {(selectable) => (
1074
+ <span>
1075
+ <input type="text" {...selectable.getTriggerProps()} />
1076
+ <ul {...selectable.getListProps()}>
1077
+ {defaultOptions.map((opt) => (
1078
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
1079
+ {opt}
1080
+ </li>
1081
+ ))}
1082
+ </ul>
1083
+ </span>
1084
+ )}
1085
+ </Selectable>
1086
+ )
1087
+ const option = screen.getByText(defaultOptions[0])
1088
+
1089
+ expect(option.tagName).toBe('LI')
1090
+ expect(option).toHaveAttribute('role', 'option')
1091
+ expect(option).toHaveAttribute('aria-selected', 'false')
1092
+ })
1093
+
1094
+ it('should set aria-selected based on selectedOptionId', async () => {
1095
+ const { container, rerender } = render(
1096
+ <Selectable selectedOptionId={defaultOptions[1]}>
1097
+ {(selectable) => (
1098
+ <span>
1099
+ <input type="text" {...selectable.getTriggerProps()} />
1100
+ <ul {...selectable.getListProps()}>
1101
+ {defaultOptions.map((opt) => (
1102
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
1103
+ {opt}
1104
+ </li>
1105
+ ))}
1106
+ </ul>
1107
+ </span>
1108
+ )}
1109
+ </Selectable>
1110
+ )
1111
+ const options = container.querySelectorAll('li')
1112
+
1113
+ expect(options[0]).toHaveAttribute('aria-selected', 'false')
1114
+ expect(options[1]).toHaveAttribute('aria-selected', 'true')
1115
+ expect(options[2]).toHaveAttribute('aria-selected', 'false')
1116
+
1117
+ // Set prop: selectedOptionId
1118
+ rerender(
1119
+ <Selectable selectedOptionId={[defaultOptions[0], defaultOptions[1]]}>
1120
+ {(selectable) => (
1121
+ <span>
1122
+ <input type="text" {...selectable.getTriggerProps()} />
1123
+ <ul {...selectable.getListProps()}>
1124
+ {defaultOptions.map((opt) => (
1125
+ <li key={opt} {...selectable.getOptionProps({ id: opt })}>
1126
+ {opt}
1127
+ </li>
1128
+ ))}
1129
+ </ul>
1130
+ </span>
1131
+ )}
1132
+ </Selectable>
1133
+ )
1134
+
1135
+ expect(options[0]).toHaveAttribute('aria-selected', 'true')
1136
+ expect(options[1]).toHaveAttribute('aria-selected', 'true')
1137
+ expect(options[2]).toHaveAttribute('aria-selected', 'false')
1138
+ })
1139
+
1140
+ it('should allow custom props to pass through', async () => {
1141
+ render(
1142
+ <Selectable>
1143
+ {(selectable) => (
1144
+ <span>
1145
+ <input type="text" {...selectable.getTriggerProps()} />
1146
+ <ul {...selectable.getListProps()}>
1147
+ {defaultOptions.map((opt) => (
1148
+ <li
1149
+ key={opt}
1150
+ {...selectable.getOptionProps({
1151
+ id: opt,
1152
+ 'data-custom-attr': true,
1153
+ className: 'customClass',
1154
+ style: { color: 'red' }
1155
+ })}
1156
+ >
1157
+ {opt}
1158
+ </li>
1159
+ ))}
1160
+ </ul>
1161
+ </span>
1162
+ )}
1163
+ </Selectable>
1164
+ )
1165
+ const option = screen.getByText(defaultOptions[0])
1166
+
1167
+ expect(option.tagName).toBe('LI')
1168
+ expect(option).toHaveAttribute('data-custom-attr', 'true')
1169
+ expect(option).toHaveClass('customClass')
1170
+ expect(option).toHaveAttribute('style', 'color: red;')
1171
+ })
1172
+
1173
+ it('should allow supplemental onClick behavior', async () => {
1174
+ const onClick = vi.fn()
1175
+ const onRequestSelectOption = vi.fn()
1176
+
1177
+ render(
1178
+ <Selectable
1179
+ isShowingOptions={true}
1180
+ onRequestSelectOption={onRequestSelectOption}
1181
+ >
1182
+ {(selectable) => (
1183
+ <span>
1184
+ <input type="text" {...selectable.getInputProps()} />
1185
+ <ul {...selectable.getListProps()}>
1186
+ {defaultOptions.map((opt) => (
1187
+ <li
1188
+ key={opt}
1189
+ {...selectable.getOptionProps({ id: opt, onClick })}
1190
+ >
1191
+ {opt}
1192
+ </li>
1193
+ ))}
1194
+ </ul>
1195
+ </span>
1196
+ )}
1197
+ </Selectable>
1198
+ )
1199
+ const option_0 = screen.getByText(defaultOptions[0])
1200
+ const option_1 = screen.getByText(defaultOptions[1])
1201
+
1202
+ userEvent.click(option_0)
1203
+ userEvent.click(option_1)
1204
+
1205
+ await waitFor(() => {
1206
+ expect(onRequestSelectOption).toHaveBeenCalledTimes(2)
1207
+ expect(onClick).toHaveBeenCalledTimes(2)
1208
+ })
1209
+ })
1210
+ })
1211
+
1212
+ describe('getDisabledOptionProps()', () => {
1213
+ it('should provide prop getter for disabled option element', async () => {
1214
+ const renderSpy = vi.fn()
1215
+
1216
+ render(
1217
+ <Selectable>
1218
+ {(selectable) => {
1219
+ renderSpy(selectable)
1220
+ return null
1221
+ }}
1222
+ </Selectable>
1223
+ )
1224
+ const args = renderSpy.mock.calls[0][0]
1225
+
1226
+ expect(args.getDisabledOptionProps).toBeDefined()
1227
+ })
1228
+
1229
+ it('should set aria-disabled prop', async () => {
1230
+ render(
1231
+ <Selectable>
1232
+ {(selectable) => (
1233
+ <span>
1234
+ <input
1235
+ type="text"
1236
+ {...selectable.getTriggerProps()}
1237
+ {...selectable.getInputProps()}
1238
+ />
1239
+ <ul {...selectable.getListProps()}>
1240
+ {defaultOptions.map((opt) => (
1241
+ <li
1242
+ key={opt}
1243
+ {...selectable.getOptionProps({ id: opt })}
1244
+ {...selectable.getDisabledOptionProps()}
1245
+ >
1246
+ {opt}
1247
+ </li>
1248
+ ))}
1249
+ </ul>
1250
+ </span>
1251
+ )}
1252
+ </Selectable>
1253
+ )
1254
+ const option = screen.getByText(defaultOptions[0])
1255
+
1256
+ expect(option.tagName).toBe('LI')
1257
+ expect(option).toHaveAttribute('aria-disabled', 'true')
1258
+ })
1259
+ })
1260
+
1261
+ describe('getDescriptionProps()', () => {
1262
+ it('should provide prop getter for description element', async () => {
1263
+ const renderSpy = vi.fn()
1264
+
1265
+ render(
1266
+ <Selectable>
1267
+ {(selectable) => {
1268
+ renderSpy(selectable)
1269
+ return null
1270
+ }}
1271
+ </Selectable>
1272
+ )
1273
+ const selectableProps = renderSpy.mock.calls[0][0]
1274
+
1275
+ expect(selectableProps.getDescriptionProps).toBeDefined()
1276
+ })
1277
+ })
1278
+ })