Beta Preview
ListBox

Testing ListBox

General setup

ListBox features long press interactions on its options depending on the option actions provided and if the user is interacting with the listbox on a touch device. Please see the following sections in the general testing documentation for more information on how to handle these behaviors in your test suite.

Timers

Long press

Test utils

@react-aria/test-utils offers common listbox interaction utilities which you may find helpful when writing tests. To install, simply add it to your dev dependencies via your preferred package manager.

Once installed, you can access the User that @react-aria/test-utils provides in your test file as shown below. This user only needs to be initialized once and then can be used to generate the ListBox tester in your test cases. This gives you access to ListBox specific utilities that you can then call within your test to query for specific subcomponents or simulate common interactions. The example test case below shows how you might go about setting up the ListBox tester, use it to simulate option selection, and verify the listbox's state after each interaction.

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

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

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

  await listboxTester.toggleOptionSelection({option: 4});
  expect(listboxTester.options()[4]).toHaveAttribute('aria-selected', 'true');
});

See below for the full definition of the User and the ListBox tester.

Properties

NameTypeDefault
advanceTimer['advanceTimer']Default: —
A function used by the test utils to advance timers during interactions. Required for certain aria patterns (e.g. table).
interactionType['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(opts: ): void
createTester<T extends >(patternName: T, opts: <T>): <T>
Creates an aria pattern tester, inheriting the options provided to the original user.

Properties

NameType
sectionsHTMLElement[]
Returns the listbox's sections if any.
selectedOptionsHTMLElement[]
Returns the listbox's selected options if any.
listboxHTMLElement
Returns the listbox.

Methods

constructor(opts: ): void
setInteractionType(type: ['interactionType']): void
Set the interaction type used by the listbox tester.
findOption(opts: {
optionIndexOrText: number | string
}): HTMLElement
Returns a option matching the specified index or text content.
toggleOptionSelection(opts: ): Promise<void>
Toggles the selection for the specified listbox option. Defaults to using the interaction type set on the listbox tester.
triggerOptionAction(opts: ): Promise<void>
Triggers the action for the specified listbox option. Defaults to using the interaction type set on the listbox tester.
options(opts: {
element?: HTMLElement
}): HTMLElement[]
Returns the listbox options. Can be filtered to a subsection of the listbox if provided via element.

Testing FAQ