Simple and complete custom Cypress commands and utilities that encourage good testing practices.
You want to use DOM Testing Library methods in your
Cypress tests.
This allows you to use all the useful
DOM Testing Library methods in your tests.
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
Typings are defined in @types/testing-library__cypress at DefinitelyTyped,
and should be added as follows in tsconfig.json:
{
"compilerOptions": {
"types": ["cypress", "@types/testing-library__cypress"]
}
}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 findBy, findAllBy, queryBy
and queryAllBy 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:
cy.configureCypressTestingLibrary(config)To show some simple examples (from cypress/integration/query.spec.js or cypress/integration/find.spec.js):
cy.queryAllByText('Button Text').should('exist')
cy.queryAllByText('Non-existing Button Text').should('not.exist')
cy.queryAllByLabelText('Label text', {timeout: 7000}).should('exist')
cy.findAllByText('Jackie Chan').click();
// findAllByText _inside_ a form element
cy.get('form').within(() => {
cy.findAllByText('Button Text').should('exist')
})
cy.get('form').then(subject => {
cy.findAllByText('Button Text', {container: subject}).should('exist')
})
cy.get('form').findAllByText('Button Text').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.
get* 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. query* also uses get* APIs, but disables retryability.
findAll* can select more than one element and is closer in functionality to how
Cypress built-in commands work. findAll* is preferred to find* queries.
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:
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.
cy.findAllByText('Some Text').should('have.length', 1)
cy.findByText('Some Text').should('exist')I'm not aware of any, if you are please make a pull request and add it here!
Thanks goes to these people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent