https://github.com/testing-library/web-testing-library
🐙 Experimental Web testing utilities that encourage good testing practices.
https://github.com/testing-library/web-testing-library
javascript testing
Last synced: 3 months ago
JSON representation
🐙 Experimental Web testing utilities that encourage good testing practices.
- Host: GitHub
- URL: https://github.com/testing-library/web-testing-library
- Owner: testing-library
- License: mit
- Created: 2023-01-14T06:55:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-03T08:45:07.000Z (over 2 years ago)
- Last Synced: 2025-09-24T00:35:09.195Z (4 months ago)
- Topics: javascript, testing
- Language: JavaScript
- Homepage: https://testing-library.com/dom
- Size: 215 KB
- Stars: 7
- Watchers: 9
- Forks: 3
- Open Issues: 2
-
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
README
Web Testing Library
Simple and complete Web testing utilities that encourage good testing
practices.
[**Read the docs**](https://testing-library.com/web) |
[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 the
[Web Platform](https://proposal-common-min-api.deno.dev/) or React Native. 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 `Web Testing Library` is a very light-weight solution for testing code that
runs on the Web Platform (a browser, [Node.js][node], [Deno](https://deno.land/)
etc) or React Native. 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] and should be installed as one of your
project's `devDependencies`:
```
npm install --save-dev @testing-library/web
```
> [**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/web)
## 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 code is used on the Web Platform or React Native.
Utilities are included in this project based on the following guiding
principles:
1. They should be usable on both the Web Platform **and** React Native
2. It should be generally useful for testing the application 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 environment, but in general, utilities should
encourage tests that use the application 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 wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Augustin Le Fèvre
🤔
Nick McCurdy
🤔
Jacob M-G Evans
🤔
Sebastian Silbermann
💻 🤔
This project follows the
[all-contributors](https://github.com/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/web-testing-library/validate?logo=github&style=flat-square
[build]: https://github.com/testing-library/web-testing-library/actions?query=workflow%3Avalidate
[coverage-badge]: https://img.shields.io/codecov/c/github/testing-library/web-testing-library.svg?style=flat-square
[coverage]: https://codecov.io/github/testing-library/web-testing-library
[version-badge]: https://img.shields.io/npm/v/@testing-library/web.svg?style=flat-square
[package]: https://www.npmjs.com/package/@testing-library/web
[downloads-badge]: https://img.shields.io/npm/dm/@testing-library/web.svg?style=flat-square
[npmtrends]: http://www.npmtrends.com/@testing-library/web
[license-badge]: https://img.shields.io/npm/l/@testing-library/web.svg?style=flat-square
[license]: https://github.com/testing-library/web-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/web-testing-library/blob/main/CODE_OF_CONDUCT.md
[github-watch-badge]: https://img.shields.io/github/watchers/testing-library/web-testing-library.svg?style=social
[github-watch]: https://github.com/testing-library/web-testing-library/watchers
[github-star-badge]: https://img.shields.io/github/stars/testing-library/web-testing-library.svg?style=social
[github-star]: https://github.com/testing-library/web-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/web-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/web-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