Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@testing-library/svelte
Advanced tools
Simple and complete Svelte testing utilities that encourage good testing practices.
@testing-library/svelte is a library for testing Svelte components. It provides utilities to render Svelte components, query elements, and simulate user interactions, making it easier to write tests that resemble how users interact with your application.
Rendering Components
This feature allows you to render Svelte components in a test environment. The `render` function returns utility functions to query the rendered component.
const { render } = require('@testing-library/svelte');
const MyComponent = require('./MyComponent.svelte');
const { getByText } = render(MyComponent);
expect(getByText('Hello World')).toBeInTheDocument();
Querying Elements
This feature provides various query functions like `getByText` and `getByRole` to find elements in the rendered component.
const { render } = require('@testing-library/svelte');
const MyComponent = require('./MyComponent.svelte');
const { getByText, getByRole } = render(MyComponent);
expect(getByText('Submit')).toBeInTheDocument();
expect(getByRole('button')).toBeInTheDocument();
Simulating User Interactions
This feature allows you to simulate user interactions like clicks, typing, etc., using the `fireEvent` utility.
const { render, fireEvent } = require('@testing-library/svelte');
const MyComponent = require('./MyComponent.svelte');
const { getByText } = render(MyComponent);
const button = getByText('Click me');
await fireEvent.click(button);
expect(getByText('Clicked')).toBeInTheDocument();
svelte-testing-library is another library for testing Svelte components. It is similar to @testing-library/svelte but may have different APIs and utilities. It focuses on providing a simple and intuitive API for testing Svelte components.
Jest is a popular testing framework that can be used to test Svelte components when combined with other libraries like @testing-library/svelte. It provides a comprehensive testing solution with features like mocking, snapshot testing, and more.
Cypress is an end-to-end testing framework that can be used to test Svelte applications. It provides a powerful and easy-to-use API for writing tests that simulate real user interactions in a browser environment.
Simple and complete Svelte testing utilities that encourage good testing practices.
You want to write tests for your Svelte components so that they avoid including implementation details, and are maintainable in the long run.
The svelte-testing-library
is a very lightweight solution for testing Svelte
components. It provides light utility functions on top of svelte
and
dom-testing-library
, 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.
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 has peerDependencies
listings for svelte >= 3
.
You may also be interested in installing @testing-library/jest-dom
so you can use
the custom jest matchers.
If you are riding the bleeding edge of Svelte 5, you'll need to either
import from @testing-library/svelte/svelte5
instead of @testing-library/svelte
, or have your vite.config.js
contains the following alias:
export default defineConfig(({ }) => ({
test: {
alias: {
'@testing-library/svelte': '@testing-library/svelte/svelte5'
}
},
}))
See the docs over at the Testing Library website.
Looking to contribute? Look for the Good First Issue label.
Please file an issue for bugs, missing documentation, or unexpected behavior.
Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
For questions related to using the library, please visit a support community instead of filing an issue on GitHub.
Thanks goes to these people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
Simple and complete Svelte testing utilities that encourage good testing practices.
The npm package @testing-library/svelte receives a total of 114,071 weekly downloads. As such, @testing-library/svelte popularity was classified as popular.
We found that @testing-library/svelte demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 15 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.