-
Notifications
You must be signed in to change notification settings - Fork 4k
/
index.tsx
419 lines (345 loc) · 10.2 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
/**
* External dependencies
*/
import { render, screen } from '@testing-library/react';
import { click, press, sleep, type } from '@ariakit/test';
/**
* WordPress dependencies
*/
import { useState } from '@wordpress/element';
/**
* Internal dependencies
*/
import UncontrolledCustomSelectControl from '..';
import type { CustomSelectProps } from '../types';
const items = [
{
key: 'flower1',
value: 'violets',
},
{
key: 'flower2',
value: 'crimson clover',
},
{
key: 'flower3',
value: 'poppy',
},
{
key: 'color1',
value: 'amber',
},
{
key: 'color2',
value: 'aquamarine',
},
];
const defaultProps = {
label: 'label!',
children: items.map( ( { value, key } ) => (
<UncontrolledCustomSelectControl.Item value={ value } key={ key } />
) ),
};
const ControlledCustomSelectControl = ( props: CustomSelectProps ) => {
const [ value, setValue ] = useState< string | string[] >();
return (
<UncontrolledCustomSelectControl
{ ...props }
onChange={ ( nextValue: string | string[] ) => {
setValue( nextValue );
props.onChange?.( nextValue );
} }
value={ value }
/>
);
};
describe.each( [
[ 'Uncontrolled', UncontrolledCustomSelectControl ],
[ 'Controlled', ControlledCustomSelectControl ],
] )( 'CustomSelectControlV2 (%s)', ( ...modeAndComponent ) => {
const [ , Component ] = modeAndComponent;
it( 'Should replace the initial selection when a new item is selected', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await click( currentSelectedItem );
await click(
screen.getByRole( 'option', {
name: 'crimson clover',
} )
);
expect( currentSelectedItem ).toHaveTextContent( 'crimson clover' );
await click( currentSelectedItem );
await click(
screen.getByRole( 'option', {
name: 'poppy',
} )
);
expect( currentSelectedItem ).toHaveTextContent( 'poppy' );
} );
it( 'Should keep current selection if dropdown is closed without changing selection', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await sleep();
await press.Tab();
await press.Enter();
expect(
screen.getByRole( 'listbox', {
name: 'label!',
} )
).toBeVisible();
await press.Escape();
expect(
screen.queryByRole( 'listbox', {
name: 'label!',
} )
).not.toBeInTheDocument();
expect( currentSelectedItem ).toHaveTextContent( items[ 0 ].value );
} );
describe( 'Keyboard behavior and accessibility', () => {
it( 'Should be able to change selection using keyboard', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await sleep();
await press.Tab();
expect( currentSelectedItem ).toHaveFocus();
await press.Enter();
expect(
screen.getByRole( 'listbox', {
name: 'label!',
} )
).toHaveFocus();
await press.ArrowDown();
await press.Enter();
expect( currentSelectedItem ).toHaveTextContent( 'crimson clover' );
} );
it( 'Should be able to type characters to select matching options', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await sleep();
await press.Tab();
await press.Enter();
expect(
screen.getByRole( 'listbox', {
name: 'label!',
} )
).toHaveFocus();
await type( 'a' );
await press.Enter();
expect( currentSelectedItem ).toHaveTextContent( 'amber' );
} );
it( 'Can change selection with a focused input and closed dropdown if typed characters match an option', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await sleep();
await press.Tab();
expect( currentSelectedItem ).toHaveFocus();
expect( currentSelectedItem ).toHaveTextContent( 'violets' );
// Ideally we would test a multi-character typeahead, but anything more than a single character is flaky
await type( 'a' );
expect(
screen.queryByRole( 'listbox', {
name: 'label!',
hidden: true,
} )
).not.toBeInTheDocument();
// This Enter is a workaround for flakiness, and shouldn't be necessary in an actual browser
await press.Enter();
expect( currentSelectedItem ).toHaveTextContent( 'amber' );
} );
it( 'Should have correct aria-selected value for selections', async () => {
render( <Component { ...defaultProps } /> );
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await click( currentSelectedItem );
// assert that first item has aria-selected="true"
expect(
screen.getByRole( 'option', {
name: 'violets',
selected: true,
} )
).toBeVisible();
// change the current selection
await click( screen.getByRole( 'option', { name: 'poppy' } ) );
// click combobox to mount listbox with options again
await click( currentSelectedItem );
// check that first item is has aria-selected="false" after new selection
expect(
screen.getByRole( 'option', {
name: 'violets',
selected: false,
} )
).toBeVisible();
// check that new selected item now has aria-selected="true"
expect(
screen.getByRole( 'option', {
name: 'poppy',
selected: true,
} )
).toBeVisible();
} );
} );
describe( 'Multiple selection', () => {
it( 'Should be able to select multiple items when provided an array', async () => {
const onChangeMock = jest.fn();
// initial selection as defaultValue
const defaultValues = [
'incandescent glow',
'ultraviolet morning light',
];
render(
<Component
defaultValue={ defaultValues }
onChange={ onChangeMock }
label="Multi-select"
>
{ [
'aurora borealis green',
'flamingo pink sunrise',
'incandescent glow',
'rose blush',
'ultraviolet morning light',
].map( ( item ) => (
<UncontrolledCustomSelectControl.Item
key={ item }
value={ item }
>
{ item }
</UncontrolledCustomSelectControl.Item>
) ) }
</Component>
);
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
// ensure more than one item is selected due to defaultValues
expect( currentSelectedItem ).toHaveTextContent(
`${ defaultValues.length } items selected`
);
await click( currentSelectedItem );
expect( screen.getByRole( 'listbox' ) ).toHaveAttribute(
'aria-multiselectable'
);
// ensure defaultValues are selected in list of items
defaultValues.forEach( ( value ) =>
expect(
screen.getByRole( 'option', {
name: value,
selected: true,
} )
).toBeVisible()
);
// name of next selection
const nextSelectionName = 'rose blush';
// element for next selection
const nextSelection = screen.getByRole( 'option', {
name: nextSelectionName,
} );
// click next selection to add another item to current selection
await click( nextSelection );
// updated array containing defaultValues + the item just selected
const updatedSelection = defaultValues.concat( nextSelectionName );
expect( onChangeMock ).toHaveBeenCalledWith( updatedSelection );
expect( nextSelection ).toHaveAttribute( 'aria-selected' );
// expect increased array length for current selection
expect( currentSelectedItem ).toHaveTextContent(
`${ updatedSelection.length } items selected`
);
} );
it( 'Should be able to deselect items when provided an array', async () => {
// initial selection as defaultValue
const defaultValues = [
'aurora borealis green',
'incandescent glow',
'key lime green',
'rose blush',
'ultraviolet morning light',
];
render(
<Component defaultValue={ defaultValues } label="Multi-select">
{ defaultValues.map( ( item ) => (
<UncontrolledCustomSelectControl.Item
key={ item }
value={ item }
>
{ item }
</UncontrolledCustomSelectControl.Item>
) ) }
</Component>
);
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
await click( currentSelectedItem );
// Array containing items to deselect
const nextSelection = [
'aurora borealis green',
'rose blush',
'incandescent glow',
];
// Deselect some items by clicking them to ensure that changes
// are reflected correctly
await Promise.all(
nextSelection.map( async ( value ) => {
await click(
screen.getByRole( 'option', { name: value } )
);
expect(
screen.getByRole( 'option', {
name: value,
selected: false,
} )
).toBeVisible();
} )
);
// expect different array length from defaultValues due to deselecting items
expect( currentSelectedItem ).toHaveTextContent(
`${
defaultValues.length - nextSelection.length
} items selected`
);
} );
} );
it( 'Should allow rendering a custom value when using `renderSelectedValue`', async () => {
const renderValue = ( value: string | string[] ) => {
return <img src={ `${ value }.jpg` } alt={ value as string } />;
};
render(
<Component label="Rendered" renderSelectedValue={ renderValue }>
<UncontrolledCustomSelectControl.Item value="april-29">
{ renderValue( 'april-29' ) }
</UncontrolledCustomSelectControl.Item>
<UncontrolledCustomSelectControl.Item value="july-9">
{ renderValue( 'july-9' ) }
</UncontrolledCustomSelectControl.Item>
</Component>
);
const currentSelectedItem = screen.getByRole( 'combobox', {
expanded: false,
} );
expect( currentSelectedItem ).toBeVisible();
// expect that the initial selection renders an image
expect( currentSelectedItem ).toContainElement(
screen.getByRole( 'img', { name: 'april-29' } )
);
expect(
screen.queryByRole( 'img', { name: 'july-9' } )
).not.toBeInTheDocument();
await click( currentSelectedItem );
// expect that the other image is only visible after opening popover with options
expect( screen.getByRole( 'img', { name: 'july-9' } ) ).toBeVisible();
expect(
screen.getByRole( 'option', { name: 'july-9' } )
).toBeVisible();
} );
} );