Teams test a variety of UI characteristics using different tools. Each tool requires you to replicate the same component state over and over. That’s a maintenance headache. Ideally, you’d set up your tests in the same way and reuse that across tools.
Storybook enables you to isolate a component and capture its use cases in a
@storybook/testing-vue3 addon is a powerful tool that simplifies the testing process by allowing you to reuse your stories inside alongside their associated mocks, dependencies, and context, saving time and ensuring consistency and accuracy in the testing process.
Run the following command to install the addon.
If you're using Storybook 7 or higher, the
@storybook/testing-vue3 addon is the only one we support. For Vue 2 users, refer to the troubleshooting section for additional guidance.
Testing Library is a suite of helper libraries for browser-based interaction tests. With Component Story Format, your stories are reusable with Testing Library. Each named export (story) is renderable within your testing setup. For example, if you were working on a login component and wanted to test the invalid credentials scenario, here's how you could write your test:
You can use Testing Library out-of-the-box with Storybook Interaction Testing.
Once the test runs, it loads the story and renders it. Testing Library then emulates the user's behavior and checks if the component state has been updated.
By default, Storybook offers a zero-config setup for React and other frameworks via addons, allowing you to run your stories as tests with Testing Library. However, if you're running tests and you've set up specific configurations in your Storybook instance (e.g., global decorators, parameters) that you want to use in your tests, you'll need to extend your test setup to include these configurations. To do so, create a
setup.js|ts file as follows:
Update your test script to include the configuration file:
By default, the
setProjectAnnotations function injects into your existing tests any global configuration you've defined in your Storybook instance (i.e., parameters, decorators in the
preview.js|ts file). Nevertheless, this may cause unforeseen side effects for tests that are not intended to use these global configurations. To avoid this, you can override the global configurations by extending either the
composeStories functions to provide test-specific configurations. For example:
You can use the
composeStory function from the appropriate framework or supported addon to allow your tests to run on a single story. However, if you're relying on this method, we recommend that you supply the story metadata (i.e., the default export) to the
composeStory function. This ensures that your tests can accurately determine the correct information about the story. For example:
If you intend to test multiple stories in a single test, use the
composeStories function from the appropriate framework or supported addon. The function will process every component story you've specified, including any
decorators you've defined. For example:
Storybook provides community-led addons for other frameworks like Vue 2 and Angular. However, these addons still lack support for the latest stable Storybook release. If you're interested in helping out, we recommend reaching out to the maintainers using the default communication channels (GitHub and Discord server).
The components returned by
composeStory not only can be rendered as React components but also come with the combined properties from the story, meta, and global configuration. This means that if you want to access args or parameters, for instance, you can do so:
When using the
composeStory functions, the components being rendered will have a combination of properties from the story, meta, and global configuration. Therefore, if you need to access the args or parameters, you can do so as follows:
- Test runner to automate test execution
- Visual tests for appearance
- Accessibility tests for accessibility
- Interaction tests for user behavior simulation
- Coverage tests for measuring code coverage
- Snapshot tests for rendering errors and warnings
- End-to-end tests for simulating real user scenarios
- Unit tests for functionality