Testing ComboBox

Test utils

@react-spectrum/test-utils offers common combobox interaction testing utilities. Install it with your preferred package manager.

npm install @react-spectrum/test-utils --dev

Initialize a User object at the top of your test file, and use it to create a ComboBox 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.

// Combobox.test.ts
import {render} from '@testing-library/react';
import {User} from '@react-spectrum/test-utils';

let testUtilUser = new User({
  interactionType: 'mouse'
});
// ...

it('ComboBox can select an option via keyboard', async function () {
  // Render your test component/app and initialize the combobox tester
  let {getByTestId} = render(
    <ComboBox data-testid="test-combobox">
      ...
    </ComboBox>
  );
  let comboboxTester = testUtilUser.createTester('ComboBox', {root: getByTestId('test-combobox'), interactionType: 'keyboard'});

  await comboboxTester.open();
  expect(comboboxTester.getListbox()).toBeInTheDocument();

  let options = comboboxTester.getOptions();
  await comboboxTester.toggleOptionSelection({option: options[0]});
  expect(comboboxTester.getCombobox().value).toBe('One');
  expect(comboboxTester.getListbox()).not.toBeInTheDocument();
});

API

User

Properties

Methods

ComboBoxTester

Testing FAQ