react-storybook-addon-props-combinations

Props Combinations addon for React Storybook

Given possible values for each prop, renders your component with all combinations of prop values. Useful for finding edge cases or just seeing all component states at once.

Live demo

Installation

Install it:

npm i -D react-storybook-addon-props-combinations

Then set the addon in your .storybook/config.js:

import { configure } from '@storybook/react'

import { setDefaults } from 'react-storybook-addon-props-combinations'

setDefaults({
  // overwrite global defaults here
})

configure(() => {
  // ...
}, module)

Basic usage

import React from 'react';
import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';

import withPropsCombinations from 'react-storybook-addon-props-combinations'

import YourComponent from './somewhere'

storiesOf('Basics', module)
  .add('Standard usage', withPropsCombinations(
    // provide your component
    YourComponent,
    // and an object with the shape
    // {propName: arrayOfPossiblevalues}
    {
      disabled: [false, true],
      onClick: [action('clicked')],
      children: ['hello world', <b>some elements</b>]
    }
  )

Options

Are provided as 4th argument to addWithPropsCombinations or set globally using setDefaults

showSource

default: true

Toggles rendering of sample source for each combination.

Example source | Result

mustProvideAllProps

default: false

Ensures that possible values are provided for all props listed in propTypes.

Example source | Result

CombinationRenderer

default implementation

A component that renders a single props combination for your component. Receives Component, props and options as props.

Example source | Result

combinationsModifier

default: x => x(identity function)

A function that takes an array of generated prop combinations, does something with it(adds new combinations, removes or modifies some of existing ones, etc), and returns that modified array. (See a list of included modifiers below)

Example source | Result

Included combination modifiers

(If you'd like to expand this list, PRs are welcome!)

withOneOfBool

Takes an array of property names and adds more combination with one of these props set to true. For example, if we had [{ label: 'my button' }], withOneOfBool(['small', 'big']) will add { label: 'my button', small: true } and { label: 'my button', big: true }.

See this story for a more detailed example.