Version:
Framework:

Snapshot tests

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

Setup Storyshots

Storyshots is the official 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.

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:

Next, update your test file (e.g., 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 the directory you've specified.

Framework configuration

By default, Storyshots detects your project's framework. If you run into 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, rax, react, react-native, riot, 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

Docs
Documentation
Add Storybook to your project in less than a minute to build components faster and easier.
Tutorial
Tutorials
Learn Storybook with in-depth tutorials that teaches Storybook best practices. Follow along with code samples.
Storybook
The MIT License (MIT). Website design by @domyen and the awesome Storybook community.
Subscribe
Get news, free tutorials, and Storybook tips emailed to you.

Maintained by
Chromatic
Continuous integration by
CircleCI
Hosting by
Netlify