---

[![Build Status][build-badge]][build]
[![Code Coverage][coverage-badge]][coverage]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]

The problem

You want to use [DOM Testing Library][dom-testing-library] methods in your
[Cypress][cypress] tests.

This solution

This allows you to use all the useful
[DOM Testing Library][dom-testing-library] methods in your tests.

Table of Contents

- Installation
- With TypeScript
- Intellisense for JavaScript with VS Code
- Usage
- Differences from DOM Testing Library
- Config testIdAttribute
- Other Solutions
- Issues
- 🐛 Bugs
- 💡 Feature Requests
- Contributors ✨
- LICENSE

Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's devDependencies:

``
npm install --save-dev @testing-library/cypress
`

$3

Typings should be added as follows in tsconfig.json:

`json
{
"compilerOptions": {
"types": ["cypress", "@testing-library/cypress"]
}
}
`

$3

If you're not using TypeScript, you use VS Code, and want to have
code-completion with the methods from this library, simply add the following
line to your project's root-level jsconfig.json file:

`json
{
"include": ["node_modules/cypress", "./cypress/*/.js"]
}
`

Usage

Cypress Testing Library extends Cypress' cy command.

Add this line to your project's cypress/support/commands.js:

`javascript
import '@testing-library/cypress/add-commands'
`

You can now use all of DOM Testing Library's findBy and findAllBy
commands.
See the DOM Testing Library docs for reference

You can find
all Library definitions here.

To configure DOM Testing Library, use the following custom command:

`javascript
cy.configureCypressTestingLibrary(config)
`

To show some simple examples (from
cypress/e2e/find.cy.js):

`javascript
cy.findAllByText('Button Text').should('exist')
cy.findAllByText('Non-existing Button Text').should('not.exist')
cy.findAllByLabelText('Label text', {timeout: 7000}).should('exist')
cy.findAllByText('Jackie Chan').click()

// findAllByText _inside_ a form element
cy.get('form').findAllByText('Button Text').should('exist')
`

$3

Cypress Testing Library supports both jQuery elements and DOM nodes. This is
necessary because Cypress uses jQuery elements, while DOM Testing Library
expects DOM nodes. When you chain a query, it will get the first DOM node from
subject of the collection and use that as the container parameter for the
DOM Testing Library functions.

query* queries are not supported. You should use the should('not.exist')
assertion instead to check for the absence of an element.

get queries are not supported. find queries do not use the Promise API of
DOM Testing Library, but instead forward to the get* queries and use
Cypress' built-in retryability using error messages from get* APIs to forward
as error messages if a query fails.

findAll* can select more than one element and is closer in functionality to
how Cypress built-in commands work. find* commands will fail if more than one
element is found that matches the criteria which is not how built-in Cypress
commands work, but is provided for closer compatibility to other Testing
Libraries.

Cypress handles actions when there is only one element found. For example, the
following will work without having to limit to only 1 returned element. The
cy.click will automatically fail if more than 1 element is returned by the
findAllByText:

`javascript
cy.findAllByText('Some Text').click()
`

If you intend to enforce only 1 element is returned by a selector, the following
examples will both fail if more than one element is found.

`javascript
cy.findAllByText('Some Text').should('have.length', 1)
cy.findByText('Some Text').should('exist')
`

Config testIdAttribute

If you would like to change the default testId from data-testId to
data-test-id, add to your project's cypress/support/index.js:

`javascript
import {configure} from '@testing-library/cypress'
configure({testIdAttribute: 'data-test-id'})
``

It accepts all configurations listed in
DOM testing library.

Other Solutions

I'm not aware of any, if you are please [make a pull request][prs] and add it
here!

Issues

_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._

$3

Please file an issue for bugs, missing documentation, or unexpected behavior.

[See Bugs][bugs]

$3

Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.

[See Feature Requests][requests]

Contributors ✨

Thanks goes to these people ([emoji key][emojis]):

Kent C. Dodds 💻 📖 🚇 ⚠️	Ivan Babak 💻 🤔	Łukasz Gandecki 💻 ⚠️	Peter Kamps 💻 📖 🤔 ⚠️	Airat Aminev 💻 ⚠️ 🔧	Adrian Smijulj 💻	Soo Jae Hwang 🐛 💻 ⚠️
Justin Hall 💻 ⚠️	euzebe 📖	jkdowdle 💻	Brian Ng 💻	Kari Laari 📖	Basti Buck 💻	ShimiTheFirst 🐛
omerose 📖	Aaron Mc Adam 💻 ⚠️	Karl Horky 📖	Stefano Magni 💻 ⚠️ 📖	Weyert de Boer 💻	Simon Jespersen 💻 👀	Adrià Fontcuberta 🚇 📖 👀
Mikhail Guskov 🐛	JD Gonzales 📖	Yvonnick FRIN 📖	Franck Abgrall 👀	Tom Robinson 💻 ⚠️	Nicholas Boll 💻 ⚠️	FlopieUtd 📖
Jaime Leonardo Suncin Cruz 🐛 💻 ⚠️	Matt Travi 💻	Michaël De Boey 💻	Hu Chen 📖	Frederick Fogerty 💻	Kyle Holmberg 📖	Mathis Møller 💻 ⚠️
Simen Bekkhus 💻	Amit Miran 🚇	Dominik Lesch 📖	Mateusz Burzyński 💻	Niels de Bruin 💻	Matan Borenkraout 💻

This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!

LICENSE

MIT

[npm]: https://npmjs.com
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/github/workflow/status/testing-library/cypress-testing-library/validate?logo=github&style=flat-square
[build]: https://github.com/testing-library/cypress-testing-library/actions?query=workflow%3Avalidate
[coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/cypress-testing-library.svg?style=flat-square
[coverage]: https://codecov.io/github/testing-library/cypress-testing-library
[version-badge]: https://img.shields.io/npm/v/@testing-library/cypress.svg?style=flat-square
[package]: https://www.npmjs.com/package/@testing-library/cypress
[downloads-badge]: https://img.shields.io/npm/dm/@testing-library/cypress.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/@testing-library/cypress
[license-badge]: https://img.shields.io/npm/l/@testing-library/cypress.svg?style=flat-square
[license]: https://github.com/testing-library/cypress-testing-library/blob/main/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: http://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/testing-library/cypress-testing-library/blob/main/other/CODE_OF_CONDUCT.md
[emojis]: https://allcontributors.org/docs/en/emoji-key
[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/testing-library/cypress-testing-library?color=orange&style=flat-square
[bugs]: https://github.com/testing-library/cypress-testing-library/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22%F0%9F%90%9B+Bug%22+sort%3Acreated-desc
[requests]: https://github.com/testing-library/cypress-testing-library/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement
[good-first-issue]: https://github.com/testing-library/cypress-testing-library/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22good+first+issue%22

[cypress]: https://cypress.io
[dom-testing-library]: https://github.com/testing-library/dom-testing-library