React Testing Library waitForElementToBeRemoved not work truely

user_4857744 0
Viewed 777

In my React application, I have a button on the screen which after clicking on it, a specific element in the screen will disappear. By Clicking the button, a state will change and after re-rendering the component, the element will disappear.

To test this scenario, I am using the React Testing library. It does not work truly by waitForElementToBeRemoved :

//element to hide
const listContainer = screen.getByRole('list'); 

//Toggle button
 const queryButton = screen.getByRole('button', {
    name: 'Query',
  })

userEvent.click(queryButton); 

//this line get error: Exceeded timeout of 20000 ms for a test.
await waitForElementToBeRemoved(() => listContainer);

but when I change waiting the process it works:

await waitFor(() => {
    expect(listContainer).not.toBeInTheDocument();
});

I don't understand why. can anyone help me?

react-testing-library reactjs frontend testing javascript
1 Answers

Change your test to use:

//Toggle button
const queryButton = screen.getByRole('button', {
 name: 'Query',
})

userEvent.click(queryButton); 

// Use queryByRole instead of getByRole
await waitForElementToBeRemoved(() => screen.queryByRole('list'));

This should work as queryByRole returns null instead of an error if an item is not found. waitFor works as it retries until the wrapped function stops throwing an error (which is what getByRole does if an element is not found). If the queryByRole change still doesn't work for you, you can additionally try incrementing the timeout e.g. await waitForElementToBeRemoved(() => screen.queryByRole('list'), {timeout: 3000);

More info on the difference between waitForElementToBeRemoved and waitFor can be found here. Also check out this article which advises to only use queryBy... whenever you need to check for the non-existence of an element.

user_2033710
Related