New
Community Showcase #5Visual test with Chromatic
Star78,835
Back to integrations
Add your integration
Categories
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon
@mixmaxhq/storybook-addon-contributors
Contributors information addon for storybook.js
npm install @mixmaxhq/storybook-addon-contributors
Last updated about 4 years ago
12
Downloads per week
Readme View on GitHub

storybook-addon-contributors

Storybook Addon Contributors allow you to view the contributors information using the Storybook UI.

This is how Contributors look like:

Getting started

First, install the addon.

$ npm add @mixmaxhq/storybook-addon-contributors --dev

Add this line to your addons.js file (create this file inside your storybook config directory if needed).

import '@mixmaxhq/storybook-addon-contributors/register';

Import the withContributors decorator to check your stories for contributors information.

import { withContributors } from '@mixmaxhq/storybook-addon-contributors';

// should only be added once
// best place is in config.js
addDecorator(withContributors)

Here is an example of using Contributors with a React component.

Button.contributors = [
  {
    name: 'Andy Tran',
    url: 'https://github.com/andyhqtran',
  },
];
Join the community
6,179 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI