Package Exports

@buildit/storybook-addon-blabbr

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 (@buildit/storybook-addon-blabbr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

storybook-addon-blabbr

Component reviewer and approver for React Storybook.

Configuration

blabbr expects to find a storybook-config.json configuration file at the root of your host, for static builds, or inside your storybook setup folder (generally .storybook). This should look like this:

{
  "storybook": {
    "blabbr": {
      "db": {
        "user": "username",
        "pwd": "password",
        "host": "db-endpoint"
      },
      "slack": {
        "endPoint": "http://your-slack-endpoint"
      },
      "ui": {
        "avatar": true
      }
    },
    "versions": {
      "regex": "\/([^\/]+?)\/?$"
    }
  }
}

The versions part is the same as in the versions addon and the above pattern will work for the format http://localhost:port/<version>/ so for example, version 0.1.2 would be expected to be found like this http://mystorybook/0.1.2/.

Storybook registration

To use the plugin you need to register the plugin and add a decorator, like most Storybook plugins.

First add the following to your addons.js file in the storybook configuration:

import '@buildit/storybook-addon-blabbr/register';

Then configure the decorator. Add the following to your config.js in the storybook configuration:

import { withComments } from '@buildit/storybook-addon-blabbr';

addDecorator(withComments);

Comment formatting

Comments are formatted using the marked package.