Cypress Testing Library

Simple and complete custom Cypress commands and utilities that encourage good testing practices.

[**Read the docs**](https://testing-library.com/cypress) | [Edit the docs](https://github.com/alexkrolick/testing-library-docs)

[![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](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat-square)](#contributors) [![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc] [![Watch on GitHub][github-watch-badge]][github-watch] [![Star on GitHub][github-star-badge]][github-star] [![Tweet][twitter-badge]][twitter]

TestingJavaScript.com Learn the smart, efficient way to test any JavaScript application.

## 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](#installation) - [With TypeScript](#with-typescript) - [Usage](#usage) - [Differences from DOM Testing Library](#differences-from-dom-testing-library) - [Other Solutions](#other-solutions) - [Contributors](#contributors) - [LICENSE](#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 ``` ### With TypeScript Typings are defined in `@types/testing-library__cypress` at [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__cypress), and should be added as follows in `tsconfig.json`: ```json { "compilerOptions": { "types": ["cypress", "@types/testing-library__cypress"] } } ``` ## 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](https://testing-library.com) You can find [all Library definitions here](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__cypress/index.d.ts). To configure DOM Testing Library, use the following custom command: ```javascript cy.configureCypressTestingLibrary(config) ``` To show some simple examples (from [cypress/integration/find.spec.js](cypress/integration/find.spec.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') ``` ### Differences from DOM Testing Library `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. `get*` and `query*` queries are disabled. `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](https://testing-library.com/docs/dom-testing-library/api-configuration). ## Other Solutions I'm not aware of any, if you are please [make a pull request][prs] and add it here! ## 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} 💻

This project follows the [all-contributors][all-contributors] specification. Contributions of any kind welcome! ## LICENSE MIT [npm]: https://www.npmjs.com/ [node]: https://nodejs.org [build-badge]: https://img.shields.io/travis/testing-library/cypress-testing-library.svg?style=flat-square [build]: https://travis-ci.org/testing-library/cypress-testing-library [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/cypress-testing-library.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/master/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/master/other/CODE_OF_CONDUCT.md [github-watch-badge]: https://img.shields.io/github/watchers/testing-library/cypress-testing-library.svg?style=social [github-watch]: https://github.com/testing-library/cypress-testing-library/watchers [github-star-badge]: https://img.shields.io/github/stars/testing-library/cypress-testing-library.svg?style=social [github-star]: https://github.com/testing-library/cypress-testing-library/stargazers [twitter]: https://twitter.com/intent/tweet?text=Check%20out%20cypress-testing-library%20by%20%40kentcdodds%20https%3A%2F%2Fgithub.com%2Fkentcdodds%2Fcypress-testing-library%20%F0%9F%91%8D [twitter-badge]: https://img.shields.io/twitter/url/https/github.com/testing-library/cypress-testing-library.svg?style=social [emojis]: https://github.com/kentcdodds/all-contributors#emoji-key [all-contributors]: https://github.com/all-contributors/all-contributors [dom-testing-library]: https://github.com/testing-library/dom-testing-library [cypress]: https://www.cypress.io/