@testing-library/dom NPM

The Problem

You want to write maintainable tests for your Web UI. As a part of this goal, you want your tests to avoid including implementation details of your components and rather focus on making your tests give you the confidence for which they are intended. As part of this, you want your testbase to be maintainable in the long run so refactors of your components (changes to implementation but not functionality) don't break your tests and slow you and your team down.

This Solution

The DOM Testing Library is a very light-weight solution for testing DOM nodes (whether simulated with JSDOM as provided by default with Jest or in the browser). The main utilities it provides involve querying the DOM for nodes in a way that's similar to how the user finds elements on the page. In this way, the library helps ensure your tests give you confidence in your UI code. The DOM Testing Library's primary guiding principle is:

The more your tests resemble the way your software is used, the more confidence they can give you.

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/dom

Docs

Documentation

Read the docs (and discover framework and tool-specific implementations) at testing-library.com

Guiding Principles

The more your tests resemble the way your software is used, the more confidence they can give you.

We try to only expose methods and utilities that encourage you to write tests that closely resemble how your web pages are used.

Utilities are included in this project based on the following guiding principles:

If it relates to rendering components, it deals with DOM nodes rather than component instances, nor should it encourage dealing with component instances.
It should be generally useful for testing the application components in the way the user would use it. We are making some trade-offs here because we're using a computer and often a simulated browser environment, but in general, utilities should encourage tests that use the components the way they're intended to be used.
Utility implementations and APIs should be simple and flexible.

At the end of the day, what we want is for this library to be pretty light-weight, simple, and understandable.

Contributors

Thanks goes to these people (emoji key):

testing ui dom jsdom unit integration functional end-to-end e2e

@babel/code-frame @babel/runtime @types/aria-query aria-query chalk dom-accessibility-api lz-string pretty-format

@testing-library/react @types/testing-library__dom @pingux/astro @rpcbase/webpack-browser int-tests maccabi pwa-fe mui-table-react jest-preset-contour initials-placeholder cra-template-teemsly-starter @rakuten-rampage/rampage react-datatable-search-pagination react-styled-components-ui @hackingbay/react-package-boilerplate @eaf.dev/react-hook-use-fetch @eaf.dev/react-router-web @kurtzgmbh/front-react-app e2e-cxs-components gbc-test-2 @everything-registry/sub-chunk-908 test-modal-component-2 test-modal-component-7 test-modal-component-8 decoris2 dev-router-vivo ember-testing-library enduthemepack enduthepack enducomp endupack2 endupack22 react-piano-ui react-router-iba-dev doloremad cra-template-js @diconium/ui-toolbox rzhm-ui role-selector scaffoldr-react react-showroom react-sms77 react_tutorial_ts reshow-unit rescript-dom-testing-library react-traph retail-react-app react-select-event react-select-event-focus-fix-test react-select-awesome react-select-without-ann richie-education riot-testing-library solid-testing-library create-vam-react dm-widget dm3-messenger-widget dm3-react dm-pack diggo-plugin capslockx.js calliope-ssg @azzykesuma/test-npm-3 panix @benbender/jest-config @calebeby/preact-testing-library @capitalg/preact-testing-library @captalys-platform/test-development-kit cipherguard-styleguide @bruno_crosier/cypress-testing-library piral-jest-utils @carv/testing-library @chance/ui-test-utils @citolab/tspci @changeset-test123/test-utils playwright-testing-library @charlytoc/dom learnpack-dom liferay-npm-scripts @symfony/stimulus-testing lunchbox-design-core pronovix-drupal-dev pronovix-frontend-tools pptr-testing-library @code-hike/sim-user components-front-end preact-testing-library-next @cross2d/sim-user @bonitour/orb-core passbolt-styleguide @bmvantunes/testing-library @curve-technology/web-ds @cutting/devtools crank-testing-library cra-template-ts @braniac/virtual-grid @bondi-js/cli pe2e-cxs-components @apitree.cz/testing-library bisonapp

11 days ago

15 days ago

3 months ago

7 months ago

7 months ago

7 months ago

7 months ago

10 months ago

10 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

@testing-library/dom v10.0.0

Table of Contents

The Problem

This Solution

Installation

Documentation

Guiding Principles

Contributors