Simple and complete Solid DOM testing utilities that encourage good testing practices.
Inspired completely by preact-testing-library
Table of Contents
The Problem
You want to write tests for your Solid components so that they avoid including implementation details, and are maintainable in the long run.
The Solution
The Solid Testing Library is a very lightweight solution for testing Solid components. 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 solid-testing-library
If you using Jest we recommend using solid-jest to properly resolve the browser version of Solid as Jest will default to the server version when run in Node.
💡 If you are using Jest or vitest, you may also be interested in installing @testing-library/jest-dom
so you can use
the custom jest matchers.
Docs
See the docs over at the Testing Library website.
There are two key difference, though:
Solid.js' reactive changes are pretty instantaneous, so there is rarely need to use waitFor(…)
or await findByRole(…)
- with the exception of transitions and Suspense.
renderHook
call has no container
, baseElement
or queries in its options or return value. Instead, it has an owner
to be used with runWithOwner
if required. It also exposes a cleanup
function, though this is already automatically called after the test is finished.
Issues
If you find any issues, please check on the issues page if they are already known. If not, opening an issue will be much appreciated, even more so if it contains a
- short description
- minimal reproduction code
- list of possible workarounds, if there are any
If you think you can fix an issue yourself, feel free to open a pull-request. If functionality changes, please don't forget to add or adapt tests.
Acknowledgment
Thanks goes to Kent C. Dodds and his colleagues for creating testing-library and to the creators of preact-testing-library.
This library has been created by Ryan Carniato and is currently maintained by Alex Lohr.