# react-storybook-addon-backgrounds

> A react storybook addon to show different backgrounds for your preview

Latest version **0.0.7** (published 2016-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-storybook-addon-backgrounds
pnpm add react-storybook-addon-backgrounds
yarn add react-storybook-addon-backgrounds
bun add react-storybook-addon-backgrounds
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2016-10-17 |
| First published | 2016-09-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 73 |
| Author | jbaxleyiii |
| Maintainers | jbaxleyiii |
| Keywords | react-storybook, react |

## Links

- npm: https://www.npmjs.com/package/react-storybook-addon-backgrounds
- Repository: https://github.com/NewSpring/react-storybook-addon-backgrounds
- Homepage: https://github.com/NewSpring/react-storybook-addon-backgrounds#readme
- Issues: https://github.com/NewSpring/react-storybook-addon-backgrounds/issues
- npm.io page: https://npm.io/package/react-storybook-addon-backgrounds

## Dependencies (1)

- [object-assign](https://npm.io/package/object-assign.md) ^4.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.7 (latest) — 2016-10-17
- 0.0.6 — 2016-10-17
- 0.0.5 — 2016-10-16
- 0.0.4 — 2016-09-11
- 0.0.3 — 2016-09-01
- 0.0.2 — 2016-09-01
- 0.0.1 — 2016-09-01

## README

<p align="center" >
  <a href="http://newspring.cc">
    <img src="https://s3.amazonaws.com/ns.images/newspring/icons/newspring-church-logo-black.png" alt="NewSpring Church" title="NewSpring Church" />
  </a>
</p>

react-storybook-addon-backgrounds
=======================
[![Build Status](https://travis-ci.org/NewSpring/react-storybook-addon-backgrounds.svg?branch=travis)](https://travis-ci.org/NewSpring/react-storybook-addon-backgrounds) [![Coverage Status](https://coveralls.io/repos/github/NewSpring/react-storybook-addon-backgrounds/badge.svg?branch=master)](https://coveralls.io/github/NewSpring/react-storybook-addon-backgrounds?branch=master)

![React Storybook Screenshot](./.storybook/backgrounds.gif)

### Getting Started

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

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

Add following content to it:

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

Then write your stories like this:

```js
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:

```bash
$ npm install # install node deps
```

To run the project locally, run:

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

To test the project run:

```bash
$ npm test
```

---
_Source: https://npm.io/package/react-storybook-addon-backgrounds · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._