@chanzuckerberg/story-utils
TypeScript icon, indicating that this package has built-in type declarations

4.0.0 • Public • Published

story-utils

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

Requirements

  • Storybook 7 (if you're using Storybook 6, use story-utils@v3)

Installation

Install @chanzuckerberg/story-utils with your favorite package manager. With yarn, that would look like

yarn add --dev @chanzuckerberg/story-utils

Utilities

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,
  },
};

Package Sidebar

Install

npm i @chanzuckerberg/story-utils

Weekly Downloads

120

Version

4.0.0

License

MIT

Unpacked Size

8.1 kB

Total Files

12

Last publish

Collaborators

  • andremalan
  • ademartini-czi
  • muggleborn
  • tzchang
  • booc0mtaco
  • girishczi
  • jinlee93
  • ahuth
  • anniehu