Skip to content

Commit d382b43

Browse files
Sync svelte docs (#1522)
sync svelte docs Co-authored-by: svelte-docs-bot[bot] <196124396+svelte-docs-bot[bot]@users.noreply.github.com>
1 parent 60edac3 commit d382b43

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

apps/svelte.dev/content/docs/svelte/07-misc/02-testing.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ export function logger(getValue) {
161161

162162
### Component testing
163163

164-
It is possible to test your components in isolation using Vitest.
164+
It is possible to test your components in isolation, which allows you to render them in a browser (real or simulated), simulate behavior, and make assertions, without spinning up your whole app.
165165

166-
> [!NOTE] Before writing component tests, think about whether you actually need to test the component, or if it's more about the logic _inside_ the component. If so, consider extracting out that logic to test it in isolation, without the overhead of a component
166+
> [!NOTE] Before writing component tests, think about whether you actually need to test the component, or if it's more about the logic _inside_ the component. If so, consider extracting out that logic to test it in isolation, without the overhead of a component.
167167
168168
To get started, install jsdom (a library that shims DOM APIs):
169169

@@ -247,6 +247,48 @@ test('Component', async () => {
247247

248248
When writing component tests that involve two-way bindings, context or snippet props, it's best to create a wrapper component for your specific test and interact with that. `@testing-library/svelte` contains some [examples](https://testing-library.com/docs/svelte-testing-library/example).
249249

250+
### Component testing with Storybook
251+
252+
[Storybook](https://storybook.js.org) is a tool for developing and documenting UI components, and it can also be used to test your components. They're run with Vitest's browser mode, which renders your components in a real browser for the most realistic testing environment.
253+
254+
To get started, first install Storybook ([using Svelte's CLI](/docs/cli/storybook)) in your project via `npx sv add storybook` and choose the recommended configuration that includes testing features. If you're already using Storybook, and for more information on Storybook's testing capabilities, follow the [Storybook testing docs](https://storybook.js.org/docs/writing-tests?renderer=svelte) to get started.
255+
256+
You can create stories for component variations and test interactions with the [play function](https://storybook.js.org/docs/writing-tests/interaction-testing?renderer=svelte#writing-interaction-tests), which allows you to simulate behavior and make assertions using the Testing Library and Vitest APIs. Here's an example of two stories that can be tested, one that renders an empty LoginForm component and one that simulates a user filling out the form:
257+
258+
```svelte
259+
/// file: LoginForm.stories.svelte
260+
<script module>
261+
import { defineMeta } from '@storybook/addon-svelte-csf';
262+
import { expect, fn } from 'storybook/test';
263+
264+
import LoginForm from './LoginForm.svelte';
265+
266+
const { Story } = defineMeta({
267+
component: LoginForm,
268+
args: {
269+
// Pass a mock function to the `onSubmit` prop
270+
onSubmit: fn(),
271+
}
272+
});
273+
</script>
274+
275+
<Story name="Empty Form" />
276+
277+
<Story
278+
name="Filled Form"
279+
play={async ({ args, canvas, userEvent }) => {
280+
// Simulate a user filling out the form
281+
await userEvent.type(canvas.getByTestId('email'), '[email protected]');
282+
await userEvent.type(canvas.getByTestId('password'), 'a-random-password');
283+
await userEvent.click(canvas.getByRole('button'));
284+
285+
// Run assertions
286+
await expect(args.onSubmit).toHaveBeenCalledTimes(1);
287+
await expect(canvas.getByText('You’re in!')).toBeInTheDocument();
288+
}}
289+
/>
290+
```
291+
250292
## E2E tests using Playwright
251293

252294
E2E (short for 'end to end') tests allow you to test your full application through the eyes of the user. This section uses [Playwright](https://playwright.dev/) as an example, but you can also use other solutions like [Cypress](https://www.cypress.io/) or [NightwatchJS](https://nightwatchjs.org/).

0 commit comments

Comments
 (0)