Test utils
@react-spectrum/test-utils offers common picker interaction testing utilities. Install it with your preferred package manager.
npm install @react-spectrum/test-utils --dev
Requirements
Please note that this library uses @testing-library/dom@10 and @testing-library/user-event@14. This means that you need to be on React 18+ in order for these utilities to work.
Initialize a User object at the top of your test file, and use it to create a Picker pattern tester in your test cases. The tester has methods that you can call within your test to query for specific subcomponents or simulate common interactions.
// Picker.test.ts
import {render} from '@testing-library/react';
import {User} from '@react-spectrum/test-utils';
let testUtilUser = new User({
interactionType: 'mouse'
});
// ...
it('Picker can select an option via keyboard', async function () {
// Render your test component/app and initialize the select tester
let {getByTestId} = render(
<Picker data-testid="test-select">
...
</Picker>
);
let selectTester = testUtilUser.createTester('Select', {root: getByTestId('test-select'), interactionType: 'keyboard'});
let trigger = selectTester.getTrigger();
expect(trigger).toHaveTextContent('Select an item');
await selectTester.toggleOptionSelection({option: 'Cat'});
expect(trigger).toHaveTextContent('Cat');
});
API
User
Properties
| Name | Type | Default |
|---|---|---|
advanceTimer | UserOpts['advanceTimer'] | Default: — |
| A function used by the test utils to advance timers during interactions. Required for certain aria patterns (e.g. table). | ||
interactionType | UserOpts['interactionType'] | Default: mouse
|
| The interaction type (mouse, touch, keyboard) that the test util user will use when interacting with a component. This can be overridden at the aria pattern util level if needed. | ||
Methods
constructor | ||
createTester | ||
| Creates an aria pattern tester, inheriting the options provided to the original user. | ||
SelectTester
constructor | ||
setInteractionType | ||
| Set the interaction type used by the select tester. | ||
open | ||
| Opens the select. Defaults to using the interaction type set on the select tester. | ||
close | ||
| Closes the select. | ||
findOption | ||
| Returns a option matching the specified index or text content. | ||
toggleOptionSelection | ||
| Toggles the selection of the desired select option if possible. Defaults to using the interaction type set on the select tester. If necessary, will open the select dropdown beforehand. The desired option can be targeted via the option's node, the option's text, or the option's index. | ||
getOptions | ||
Returns the select's options if present. Can be filtered to a subsection of the listbox if
provided via element. | ||
getTrigger | ||
| Returns the select's trigger. | ||
getListbox | ||
| Returns the select's listbox if present. | ||
getSections | ||
| Returns the select's sections if present. | ||