Skip to content

chris-verclytte/react-storybook-addon-backgrounds

 
 

Repository files navigation

NewSpring Church

react-storybook-addon-backgrounds

Build Status Coverage Status

React Storybook Screenshot

Getting Started

npm i --save react-storybook-addon-backgrounds

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

Add following content to it:

import '@kadira/storybook/addons';
import 'react-storybook-addon-backgrounds/register';

Then write your stories like this:

import React from 'react';
import { storiesOf } from "@kadira/storybook";
import backgrounds from "react-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

About

A React Storybook addon to customize the background of your preview

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.4%
  • JavaScript 5.6%