@testing-library/svelte v5.2.6
Table of Contents
The Problem
You want to write maintainable tests for your Svelte components.
This Solution
@testing-library/svelte
is a lightweight library for testing Svelte
components. It provides functions on top of svelte
and
@testing-library/dom
so you can mount Svelte components and query their
rendered output in the DOM. 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/svelte
This library supports svelte
versions 3
, 4
, and 5
.
You may also be interested in installing @testing-library/jest-dom
so you can
use the custom jest matchers.
Setup
We recommend using @testing-library/svelte
with Vitest as your test
runner. To get started, add the svelteTesting
plugin to your Vite or Vitest
config.
// vite.config.js
import { svelte } from '@sveltejs/vite-plugin-svelte'
+ import { svelteTesting } from '@testing-library/svelte/vite'
export default defineConfig({
plugins: [
svelte(),
+ svelteTesting(),
]
});
See the setup docs for more detailed setup instructions, including for other test runners like Jest.
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.
💡 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.
❓ 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):
This project follows the all-contributors specification. Contributions of any kind welcome!
1 month ago
1 month ago
2 months ago
3 months ago
3 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
10 months ago
10 months ago
11 months ago
1 year ago
11 months 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
3 years ago
3 years ago
3 years ago
3 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
6 years ago
6 years ago
6 years ago