Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/testing-library/dom-testing-library

🐙 Simple and complete DOM testing utilities that encourage good testing practices.
https://github.com/testing-library/dom-testing-library
javascript testing
Last synced: 5 days ago
JSON representation
🐙 Simple and complete DOM testing utilities that encourage good testing practices.
Host: GitHub
URL: https://github.com/testing-library/dom-testing-library
Owner: testing-library
License: mit
Created: 2018-04-06T13:08:11.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-04-10T13:49:33.000Z (7 months ago)
Last Synced: 2024-04-12T17:14:31.946Z (7 months ago)
Topics: javascript, testing
Language: JavaScript
Homepage: https://testing-library.com/dom
Size: 1.67 MB
Stars: 3,227
Watchers: 33
Forks: 454
Open Issues: 91
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project

awesome - dom-testing-library - 🐙 Simple and complete DOM testing utilities that encourage good testing practices. (JavaScript)
awesome-list - dom-testing-library - library | 2633 | (JavaScript)
README

        


DOM Testing Library




  



Simple and complete DOM testing utilities that encourage good testing

practices.


[**Read the docs**](https://testing-library.com/dom) |

[Edit the docs](https://github.com/testing-library/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][all-contributors-badge]](#contributors)

[![PRs Welcome][prs-badge]][prs]

[![Code of Conduct][coc-badge]][coc]

[![Discord][discord-badge]][discord]

[![Watch on GitHub][github-watch-badge]][github-watch]

[![Star on GitHub][github-star-badge]][github-star]

[![Tweet][twitter-badge]][twitter]



  

    

  



## Table of Contents

- [The Problem](#the-problem)

- [This Solution](#this-solution)

- [Installation](#installation)

- [Documentation](#documentation)

- [Guiding Principles](#guiding-principles)

- [Contributors](#contributors)

- [LICENSE](#license)

## 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`](https://github.com/jsdom/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.][guiding-principle]

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

```

> [**Docs**](https://testing-library.com/docs/install)

## Documentation

Read the docs (and discover framework and tool-specific implementations) at

[testing-library.com](https://testing-library.com/dom)

## Guiding Principles

> [The more your tests resemble the way your software is used, the more

> confidence they can give you.][guiding-principle]

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:

1.  If it relates to rendering components, it deals with DOM nodes rather than

    component instances, nor should it encourage dealing with component

    instances.

2.  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.

3.  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][emojis]):

  

    

      
_{Kent C. Dodds}
💻 📖 🚇 ⚠️

      
_{Greg Bergé}
🤔

      
_{Ryan Castner}
📖

      
_{Daniel Sandiego}
💻

      
_{Paweł Mikołajczyk}
💻

      
_{Alejandro Ñáñez Ortiz}
📖

      
_{Matt Parrish}
🐛 💻 📖 ⚠️

    

    

      
_{Justin Hall}
📦

      
_{Anto Aravinth}
💻 ⚠️ 📖

      
_{Jonah Moses}
📖

      
_{Łukasz Gandecki}
💻 ⚠️ 📖

      
_{Ivan Babak}
🐛 🤔 💻 📖

      
_{Jesse Day}
💻

      
_{Ernesto García}
💬 💻 📖

    

    

      
_{Josef Maxx Blake}
💻 📖 ⚠️

      
_{Alex Cook}
📖 💡 👀

      
_{Daniel Cook}
💻 📖 ⚠️

      
_{Thomas Chia}
🐛 💻

      
_{Tim Deschryver}
💻 ⚠️ 👀

      
_{Alex Krolick}
💻

      
_{Maddi Joyce}
💻

    

    

      
_{Peter Kamps}
🐛 💻 ⚠️

      
_{Jonathan Stoye}
📖 💻

      
_{Sanghyeon Lee}
💡

      
_{Justice Mba}
💻 📖 🤔

      
_{Wayne Crouch}
💻

      
_{Ben Elliott}
💻

      
_{Ruben Costa}
💻

    

    

      
_{Robert Smith}
🐛 🤔 📖

      
_dadamssg
💻

      
_{Neil Kistner}
💻 ⚠️

      
_{Ben Chauvette}
💻

      
_{Jeff Baumgardt}
💻 📖

      
_{Matan Kushner}
💻 📖 🤔 ⚠️

      
_{Alex Wendte}
💻 📖 ⚠️

    

    

      
_{Tamas Fodor}
📖

      
_{Benjamin Eckardt}
💻

      
_{Ryan Campbell}
📖

      
_{Taylor Briggs}
⚠️

      
_{John Gozde}
💻

      
_{C. T. Lin}
📖

      
_{Terrence Wong}
💻

    

    

      
_{Soo Jae Hwang}
💻

      
_{Royston Shufflebotham}
🐛 💻 📖 ⚠️

      
_{Vadim Brodsky}
💻

      
_{Eunjae Lee}
💻

      
_{David Peter}
💻

      
_{Shy Alter}
💻 📖

      
_{Łukasz Makuch}
📦

    

    

      
_{Tyler Haas}
💻 ⚠️

      
_{Vesa Laakso}
💻 ⚠️

      
_{Tulsi Sapkota}
💻

      
_{Tiago Nunes}
💻 ⚠️

      
_JaxCavalera
💻 👀

      
_bopfer
⚠️

      
_{Jan Pfitzner}
💻

    

    

      
_David
💻

      
_{Diego Hernandez}
💻 ⚠️

      
_{Alex Young}
💻

      
_{Paul Armstrong}
💻 ⚠️

      
_{Tamás Szabó}
💻 ⚠️

      
_{Dylan Piercey}
💻 ⚠️

      
_{Michael Lasky}
💻 ⚠️ 📖

    

    

      
_{Sebastian Silbermann}
💻 ⚠️ 📖 🚇 👀

      
_{Dylan Vann}
💻

      
_{Adrià Fontcuberta}
💻 ⚠️ 📖

      
_{Thomas Lombart}
💻

      
_{Sam Horton}
💻 ⚠️

      
_{Andrew Hill}
💻

      
_{Jan Amann}
💻 ⚠️

    

    

      
_{Brais Piñeiro}
💻 ⚠️

      
_{Dominykas Blyžė}
💻 ⚠️

      
_{Olzhas Askar}
💻 ⚠️ 📖

      
_{Max Belsky}
💻 ⚠️

      
_{Michael Mantel}
⚠️

      
_{Tom Nagle}
💻

      
_{Westbrook Johnson}
💻

    

    

      
_{Mohammad Aziz}
💻 ⚠️

      
_seetdev
⚠️ 💻

      
_{Xavier Garcia Buils}
💻 ⚠️

      
_aw-davidson
💻 ⚠️

      
_{Michaël De Boey}
💻

      
_{Minh Nguyen}
💻

      
_{Egill Sveinbjörnsson}
💻

    

    

      
_{Pavel Pustovalov}
📖

      
_{Adam Palaniuk}
💻 ⚠️

      
_Yama-Tomo
💻 ⚠️

      
_{Aaron Pettengill}
💻 ⚠️

      
_{Kate W. Boyd}
💻

      
_{Rahul Suryakanth}
💻 ⚠️

      
_Jamie
💻 ⚠️

    

    

      
_{Nicolas Stepien}
💻

      
_{Ken Powers}
💻

      
_{Michał Zdunek}
💻

      
_{Ali Nasserzadeh}
💻

      
_{Darek Kay}
📖 💻 ⚠️

      
_Lukas
💻 ⚠️

      
_{Tom Crockett}
💻 ⚠️

    

    

      
_{Kevin Brewer}
💻 ⚠️

      
_{Ben Monro}
💻 🤔 ⚠️ 📖

      
_{Stephan Meijer}
🤔 💻 ⚠️

      
_{João Forja}
💻 ⚠️

      
_{Nick McCurdy}
📖 💻 ⚠️ 👀 🚇

      
_{Caleb Meredith}
💻

      
_{Marco Moretti}
💻 ⚠️ 👀

    

    

      
_{Travis Jefferson}
💻 ⚠️

      
_{Maciej Jastrzebski}
🐛

      
_{Geoff Harcourt}
💻

      
_{Josh Goldberg}
💻 ⚠️

      
_{Ken Gregory}
💻 ⚠️

      
_{Jacob Paris}
💻 ⚠️

      
_{keiya sasaki}
📖

    

    

      
_{Idan Entin}
💻 ⚠️

      
_{Deniz Susman}
💻

      
_{Bianca Del Carretto}
⚠️ 💻

      
_{Josh Lalonde}
💻 ⚠️

      
_{Ioannis Papadopoulos}
💻 ⚠️

      
_{Maxwell Newlands}
💻 ⚠️

      
_{Jared Luxenberg}
💻 ⚠️

    

    

      
_snizhana
💻 ⚠️

      
_{Michael van Engelshoven}
👀

      
_{Asher Tuggle}
🐛

      
_{Winter LaMon}
💻 ⚠️

      
_{Victor Cordova}
💻 ⚠️

      
_slowselfip
🐛

      
_{Dmitry Semigradsky}
💻

    

    

      
_Adam
💻 ⚠️

      
_balavishnuvj
💻

      
_{Chris Colborne}
💻

      
_{Romain Trotard}
💻

      
_{Thomas Marshall}
💻 ⚠️

      
_{johnjessewood}
🐛 💻

      
_{Ari Perkkiö}
🐛 💻 📖

    

    

      
_{Nathan Force}
💻

      
_{Philipp Fritsche}
💻

      
_{Renato Alencar}
💻 ⚠️

      
_{Simen Bekkhus}
🐛

      
_{Dan Abramov}
🐛 👀

      
_{Matan Borenkraout}
💻

      
_simcha90
💻

    

    

      
_{Amit Miran}
🚇

      
_{Dominik Lesch}
📖

      
_{Gareth Jones}
💻 ⚠️

      
_{Rayat Rahman}
💻

      
_{Nik Savchenko}
💻

      
_{Kevin Fleischman}
💻 ⚠️

      
_{Beth Hitch}
💻

    

    

      
_{Jack Laurence}
💻

      
_SantoJambit
💻

      
_{Yashu Mittal}
📖

      
_{Ian VanSchooten}
💻

      
_{Vanya Prokopovich}
🐛

      
_{James Nail}
🐛

      
_{Rob Caldecott}
🐛

    

    

      
_Dennis273
💻

      
_{Jackson Hardaker}
⚠️

      
_{Robin Drexler}
💻

      
_{Omer Dolev}
💻

      
_Lirlev48
💻

      
_{Tarnay Kálmán}
💻

      
_{Than Hutchins}
💻

    

    

      
_{Raphaël LEMIEUX}
💻

      
_{Arthur Lauck Vilas Boas}
📖

      
_{Daniel Acuña}
💻

      
_{Craig Morten}
💻 💬

      
_{Naor Peled}
💻

      
_{Julien Wajsberg}
💻 🐛

      
_{Kevin BON}
💻 🐛

    

    

      
_sieem
💻

    

  

This project follows the [all-contributors][all-contributors] specification.

Contributions of any kind welcome!

## LICENSE

[MIT](LICENSE)

[npm]: https://www.npmjs.com/

[node]: https://nodejs.org

[build-badge]: https://img.shields.io/github/workflow/status/testing-library/dom-testing-library/validate?logo=github&style=flat-square

[build]: https://github.com/testing-library/dom-testing-library/actions?query=workflow%3Avalidate

[coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/dom-testing-library.svg?style=flat-square

[coverage]: https://codecov.io/github/testing-library/dom-testing-library

[version-badge]: https://img.shields.io/npm/v/@testing-library/dom.svg?style=flat-square

[package]: https://www.npmjs.com/package/@testing-library/dom

[downloads-badge]: https://img.shields.io/npm/dm/@testing-library/dom.svg?style=flat-square

[npmtrends]: http://www.npmtrends.com/@testing-library/dom

[license-badge]: https://img.shields.io/npm/l/@testing-library/dom.svg?style=flat-square

[license]: https://github.com/testing-library/dom-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/dom-testing-library/blob/main/CODE_OF_CONDUCT.md

[github-watch-badge]: https://img.shields.io/github/watchers/testing-library/dom-testing-library.svg?style=social

[github-watch]: https://github.com/testing-library/dom-testing-library/watchers

[github-star-badge]: https://img.shields.io/github/stars/testing-library/dom-testing-library.svg?style=social

[github-star]: https://github.com/testing-library/dom-testing-library/stargazers

[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20dom-testing-library%20by%20%40testing-library%20https%3A%2F%2Fgithub.com%2Ftesting-library%2Fdom-testing-library%20%F0%9F%91%8D

[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/testing-library/dom-testing-library.svg?style=social

[emojis]: https://github.com/all-contributors/all-contributors#emoji-key

[all-contributors]: https://github.com/all-contributors/all-contributors

[all-contributors-badge]: https://img.shields.io/github/all-contributors/testing-library/dom-testing-library?color=orange&style=flat-square

[set-immediate]: https://developer.mozilla.org/en-US/docs/Web/API/Window/setImmediate

[guiding-principle]: https://twitter.com/kentcdodds/status/977018512689455106

[jest]: https://facebook.github.io/jest

[discord-badge]: https://img.shields.io/discord/723559267868737556.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square

[discord]: https://discord.gg/testing-library