New
Storybook’s Visual Tests addon enters betaVisual test with Chromatic
Star82,046

Snapshot testing with Storyshots

Snapshot tests compare the rendered markup of every story against known baselines. It’s a way to identify markup changes that trigger rendering errors and warnings.

Storybook is a helpful tool for snapshot testing because every story is essentially a test specification. Any time you write or update a story, you get a snapshot test for free.

Example Snapshot test

Migrating Tests

The Storyshots addon was the original testing solution for Storybook, offering a highly extensible API and a wide range of configuration options for testing. However, it was difficult to set up and maintain, and it needed to be compatible with the latest version of Storybook, which introduced some significant architectural changes, including a high-performance on-demand story loading feature. As a result, Storyhots is now officially deprecated, is no longer being maintained, and will be removed in the next major release of Storybook. We recommend following the migration guide we've prepared to help you during this transition period.

Set up Storyshots

The Storyshots addon has been deprecated and will be removed in a future release of Storybook. See the migration guide for more information.

Storyshots is a Storybook addon that enables snapshot testing, powered by Jest.

Run the following command to install Storyshots:

Add a test file to your environment with the following contents to configure Storyshots:

You can name the test file differently to suit your needs. Bear in mind that it requires to be picked up by Jest.

Run your first test. Storyshots will recognize your stories (based on .storybook/main.js's setup) and save them in the snapshots directory.

Terminal
Loading...

Successful snapshot tests

When you make changes to your components or stories, rerun the test to identify the changes to the rendered markup.

Failing snapshots

If they're intentional, accept them as new baselines. If the changes are bugs, fix the underlying code, then rerun the snapshot tests.

Configure the snapshot's directory

If your project has a custom setup for snapshot testing, you'll need to take additional steps to run Storyshots. You'll need to install both @storybook/addon-storyshots-puppeteer and puppeteer:

Terminal
Loading...

Next, update your test file (for example, storybook.test.js) to the following:

Don't forget to replace your-custom-directory with your own.

When you run your tests, the snapshots will be available in your specified directory.

Framework configuration

By default, Storyshots detects your project's framework. If you encounter a situation where this is not the case, you can adjust the configuration object and specify your framework. For example, if you wanted to configure the addon for a Vue 3 project:

These are the frameworks currently supported by Storyshots: angular, html, preact, react, react-native, svelte, vue, vue3, and web-components.

Additional customization

Storyshots is highly customizable and includes options for various advanced use cases. You can read more in the addon’s documentation.


What’s the difference between snapshot tests and visual tests?

Visual tests capture images of stories and compare them against image baselines. Snapshot tests take DOM snapshots and compare them against DOM baselines. Visual tests are better suited for verifying appearance. Snapshot tests are useful for smoke testing and ensuring the DOM doesn’t change.

Learn about other UI tests

Was this page helpful?

Markdown accepted ([link text](url), _italic_, **bold**, etc). Your anonymous feedback will be posted publicly on GitHub.

✍️ Edit on GitHub – PRs welcome!
Storybook
Join the community
6,490 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI