Michael Shilman 2e1fe20fc6 v3.2.17
2017-12-03 11:59:11 -08:00
..
2017-11-10 23:59:40 +03:00
2017-12-03 11:59:11 -08:00
2017-11-02 20:20:27 +01:00
2017-11-04 03:39:54 +03:00

addon-backgrounds

Build Status

React Storybook Screenshot

Getting Started

npm i --save @storybook/addon-backgrounds

Then create a file called addons.js in your storybook config.

Add following content to it:

import '@storybook/addon-backgrounds/register';

Then write your stories like this:

import React from 'react';
import { storiesOf } from "@storybook/react";
import backgrounds from "@storybook/addon-backgrounds";

storiesOf("Button", module)
  .addDecorator(backgrounds([
    { name: "twitter", value: "#00aced", default: true },
    { name: "facebook", value: "#3b5998" },
  ]))
  .add("with text", () => <button>Click me</button>);

Development

This project is built using typescript and is tested with jest. To get started, clone this repo and run the following command:

$ npm install # install node deps

To run the project locally, run:

$ npm run storybook # for storybook testing
# (coming soon) $ npm run test-watch # for testing

To test the project run:

$ npm test