Package Exports

@testing-library/cypress
@testing-library/cypress/add-commands

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@testing-library/cypress) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cypress-testing-library

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

Read the docs | Edit the docs

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

The problem

You want to use dom-testing-library methods in your Cypress tests.

This solution

This allows you to use all the useful dom-testing-library methods in your tests.

Installation
- With typescript
Usage
Other Solutions
Contributors
LICENSE

Installation

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

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

With typescript

Typings are defined under @testing-library/cypress/typings, and should be added as follows in tsconfig.json:

{
  "compilerOptions": {
    "types": ["cypress", "../@testing-library/cypress/typings"]
  }
}

Or if tsconfig.json has a baseUrl of ../node_modules as recommended in the official Cypress documentation use:

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

Usage

cypress-testing-library extends Cypress' cy command.

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

import '@testing-library/cypress/add-commands';

You can now use all of dom-testing-library's getBy, getAllBy, queryBy and queryAllBy commands. See the dom-testing-library docs for reference

You can find all Library definitions here.

To show some simple examples (from cypress/integration/commands.spec.js):

cy.getAllByText('Jackie Chan').click()
cy.queryByText('Button Text').should('exist')
cy.queryByText('Non-existing Button Text').should('not.exist')
cy.queryByLabelText('Label text', {timeout: 7000}).should('exist')
cy.get('form').within(() => {
  cy.getByText('Button Text').should('exist')
})
cy.get('form').then(subject => {
  cy.getByText('Button Text', {container: subject}).should('exist')
})

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 pass a jQuery element as container, it will get the first DOM node from the collection and use that as the container parameter for the dom-testing-library functions.

Contributors

Thanks goes to these people (emoji key):

_{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} 💻 ⚠️