story-utils

Utilities for using Storybook stories in non-Storybook environments. For example, using stories in Jest tests.

Requirements

• Storybook 7 or 8
  • If you're using Storybook Storybook 6, use story-utils@v3

Installation

Install @chanzuckerberg/story-utils with your favorite package manager.

npm install --save-dev @chanzuckerberg/story-utils

Utilities

• generateSnapshots

generateSnapshots

Auto generates snapshots for stories

import * as snapshotTestStoryFile from "./MyButton.stories";
import { generateSnapshots } from "@chanzuckerberg/story-utils";

describe("My button", () => {
  generateSnapshots(snapshotTestStoryFile);
});

If you want to skip generating snapshots for a story:

SomeStory.parameters = {
  snapshot: {
    skip: true,
  },
};

wait(ms: number) => void

A utility function that can be used to wait for when testing in react

import { wait } from "@chanzuckerberg/story-utils";

test('example', async () => {
  renderSomething()
  await wait();

  // add expect matchers after
})