API reference

React Testing Library API reference

React Testing Library

Identifiers: 104
With full guides: 0
Types: 4

Topics covered

getBy / findBy queries
user-event
Async UI testing
Mocking fetch
Testing hooks
Accessibility queries
Testing forms
Best practices

Function

Name	What it does
`render`	Function
`fireEvent`	Function
`waitFor`	Function
`within`	Function
`getByRole`	Function
`getByText`	Function
`findByText`	Function
`queryByText`	Function
`renderHook`	Function
`getByLabelText`	Function
`getByPlaceholderText`	Function
`getByTestId`	Function
`queryByRole`	Function
`findByRole`	Function
`waitForElementToBeRemoved`	Function
`act`	Function
`cleanup`	Function
`prettyDOM`	Function
`configure`	Function
`logRoles`	Function
`getDefaultNormalizer`	Function
`getRoles`	Function
`getNodeText`	Function

Const

Name	What it does
`screen`	Const
`userEvent`	Const

Module

Name	What it does
`getByAltText`	Module
`getByTitle`	Module
`getByDisplayValue`	Module
`queryByLabelText`	Module
`queryByTestId`	Module
`findByLabelText`	Module
`findByTestId`	Module
`getAllByRole`	Module
`getAllByText`	Module
`queryAllByRole`	Module
`findAllByRole`	Module
`getAllByTestId`	Module
`userEvent.setup`	Module
`userEvent.click`	Module
`userEvent.dblClick`	Module
`userEvent.type`	Module
`userEvent.keyboard`	Module
`userEvent.clear`	Module
`userEvent.selectOptions`	Module
`userEvent.deselectOptions`	Module
`userEvent.upload`	Module
`userEvent.hover`	Module
`userEvent.unhover`	Module
`userEvent.tab`	Module
`userEvent.paste`	Module
`userEvent.pointer`	Module
`fireEvent.click`	Module
`fireEvent.change`	Module
`fireEvent.submit`	Module
`fireEvent.keyDown`	Module
`fireEvent.keyUp`	Module
`fireEvent.focus`	Module
`fireEvent.blur`	Module
`fireEvent.mouseOver`	Module
`fireEvent.mouseEnter`	Module
`fireEvent.input`	Module
`toBeInTheDocument`	Module
`toBeVisible`	Module
`toBeDisabled`	Module
`toBeEnabled`	Module
`toBeChecked`	Module
`toBeRequired`	Module
`toBeValid`	Module
`toBeInvalid`	Module
`toHaveValue`	Module
`toHaveTextContent`	Module
`toHaveClass`	Module
`toHaveAttribute`	Module
`toHaveStyle`	Module
`toHaveFocus`	Module
`toContainElement`	Module
`toContainHTML`	Module
`toHaveAccessibleName`	Module
`toHaveAccessibleDescription`	Module
`toBeEmptyDOMElement`	Module
`toHaveDisplayValue`	Module
`toHaveFormValues`	Module
`toBePartiallyChecked`	Module
`queryByAltText`	Module
`queryByTitle`	Module
`queryByDisplayValue`	Module
`queryByPlaceholderText`	Module
`findByAltText`	Module
`findByPlaceholderText`	Module
`getAllByLabelText`	Module
`getAllByPlaceholderText`	Module
`getAllByAltText`	Module
`getAllByTitle`	Module
`getAllByDisplayValue`	Module
`fireEvent.scroll`	Module
`fireEvent.drop`	Module
`fireEvent.paste`	Module
`fireEvent.contextMenu`	Module

Pipe

Name	What it does
`container`	Pipe
`rerender`	Pipe
`unmount`	Pipe
`asFragment`	Pipe
`baseElement`	Pipe
`debug`	Pipe

Search across every package and filter by type in your dashboard.

Start learning