JSPM

  • Created
  • Published
  • Downloads 15139
  • Score
    100M100P100Q143288F
  • License MIT

A happo.io plugin for projects using Storybook

Package Exports

  • happo-plugin-storybook

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (happo-plugin-storybook) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

happo-plugin-storybook

A happo.io plugin for Storybook. See https://medium.com/happo-io/cross-browser-screenshot-testing-with-happo-io-and-storybook-bfb0b848a97a for a lengthier introduction to this plugin.

Usage

Add the following to your .happo.js configuration file:

// .happo.js
const happoPluginStorybook = require('happo-plugin-storybook');

module.exports = {
  // ...
  plugins: [
    happoPluginStorybook({
      // options go here
    }),
  ],
}

Options

  • configDir specify the name of the Storybook configuration directory. The default is .storybook.
  • ignoredStories an array of story names that you want to exclude from the Happo test suite. The default is an empty array [].

Additionally, if you want to have better control over what addons and/or decorators get loaded you can look for a global HAPPO variable in your Storybook config. E.g.

// .storybook/config.js

const isHappoRun = typeof HAPPO !== 'undefined';

if (!isHappoRun) {
  // load some addons/decorators that happo won't use
} else {
  // load some addons/decorators that happo will use
}