• Stars
    star
    139
  • Rank 262,954 (Top 6 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 6 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Simple and complete Preact DOM testing utilities that encourage good testing practices.

Preact Testing Library

poodle

Simple and complete Preact DOM testing utilities that encourage good testing practices.

Inspired completely by react-testing-library

Build Status Code Coverage All Contributors PRs Welcome Code of Conduct version downloads MIT License Preact Slack Community Commitzen Discord


Table of Contents

The Problem

You want to write tests for your Preact components so that they avoid including implementation details, and are maintainable in the long run.

The Solution

The Preact Testing Library is a very lightweight solution for testing Preact components. It provides light utility functions on top of preact/test-utils, in a way that encourages better testing practices. Its 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/preact

This library has peerDependencies listings for preact >= 10.

๐Ÿ’ก You may also be interested in installing @testing-library/jest-dom so you can use the custom jest matchers.

๐Ÿ“ This library supports Preact X (10.x). It takes advantage of the act test utility in preact/test-utils to enable both Preact Hook and Class components to be easily tested.

๐Ÿ“ If you're looking for a solution for Preact 8.x then install preact-testing-library.

Docs

See the docs over at the Testing Library website.

Issues

Looking to contribute? Look for the Good First Issue label.

๐Ÿ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

๐Ÿ’ก Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a ๐Ÿ‘. This helps maintainers prioritize what to work on.

See Feature Requests

โ“ Questions

For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

Contributors

Thanks goes to these people (emoji key):

Kent C. Dodds
Kent C. Dodds

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Ants Martian
Ants Martian

๐Ÿ’ป ๐Ÿ“– โš ๏ธ
Rahim Alwer
Rahim Alwer

๐Ÿ’ป ๐Ÿ“– โš ๏ธ ๐Ÿš‡

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT

More Repositories

1

react-testing-library

๐Ÿ Simple and complete React DOM testing utilities that encourage good testing practices.
JavaScript
18,952
star
2

react-hooks-testing-library

๐Ÿ Simple and complete React hooks testing utilities that encourage good testing practices.
TypeScript
5,083
star
3

jest-dom

๐Ÿฆ‰ Custom jest matchers to test the state of the DOM
JavaScript
4,422
star
4

dom-testing-library

๐Ÿ™ Simple and complete DOM testing utilities that encourage good testing practices.
JavaScript
3,271
star
5

user-event

๐Ÿ• Simulate user events
TypeScript
2,181
star
6

cypress-testing-library

๐Ÿ… Simple and complete custom Cypress commands and utilities that encourage good testing practices.
JavaScript
1,798
star
7

vue-testing-library

๐ŸฆŽ Simple and complete Vue.js testing utilities that encourage good testing practices.
JavaScript
1,071
star
8

eslint-plugin-testing-library

ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library
TypeScript
979
star
9

testing-playground

Simple and complete DOM testing playground that encourage good testing practices.
JavaScript
776
star
10

angular-testing-library

๐Ÿฆ” Simple and complete Angular testing utilities that encourage good testing practices
TypeScript
626
star
11

svelte-testing-library

๐Ÿฟ๏ธ Simple and complete Svelte DOM testing utilities that encourage good testing practices
JavaScript
615
star
12

native-testing-library

๐Ÿณ Simple and complete React Native testing utilities that encourage good testing practices.
JavaScript
515
star
13

testing-library-docs

docs site for @testing-library/*
JavaScript
449
star
14

jest-native

๐Ÿฆ… Custom jest matchers to test the state of React Native
TypeScript
436
star
15

eslint-plugin-jest-dom

eslint rules for use with jest-dom
JavaScript
360
star
16

pptr-testing-library

puppeteer + dom-testing-library = ๐Ÿ’–
TypeScript
283
star
17

playwright-testing-library

๐Ÿ” Find elements in Playwright with queries from Testing Library
TypeScript
248
star
18

testing-library-recorder-extension

Testing Library Extension for Chrome DevTools Recorder
TypeScript
144
star
19

which-query

๐Ÿฆฉ Which query should I use?
CSS
124
star
20

testcafe-testing-library

๐Ÿ‚ Simple and complete custom Selectors for Testcafe that encourage good testing practices.
TypeScript
71
star
21

preact-hooks-testing-library

Simple and complete Preact hooks testing utilities that encourage good testing practices.
TypeScript
56
star
22

jasmine-dom

๐Ÿฆฅ Custom Jasmine matchers to test the state of the DOM
JavaScript
45
star
23

nightwatch-testing-library

๐Ÿฆ‡Simple and complete custom queries for Nightwatch that encourage good testing practices.
JavaScript
31
star
24

dom-testing-library-template

Template repository for bug reports to @testing-library/dom, @testing-library/react, and @testing-library/jest-dom
JavaScript
17
star
25

webdriverio-testing-library

๐Ÿ•ท๏ธ Simple and complete WebdriverIO DOM testing utilities that encourage good testing practices.
TypeScript
16
star
26

native-testing-library-docs

๐Ÿณ Docs site for native-testing-library
JavaScript
16
star
27

react-testing-library-help

Fork this repo to reproduce your issue
HTML
12
star
28

web-testing-library

๐Ÿ™ Experimental Web testing utilities that encourage good testing practices.
JavaScript
3
star