https://github.com/mixmaxhq/storybook-addon-contributors

Contributors information addon for storybook.js
https://github.com/mixmaxhq/storybook-addon-contributors

storybook storybook-addon supported

Last synced: about 1 month ago
JSON representation

Contributors information addon for storybook.js

• Host: GitHub
• URL: https://github.com/mixmaxhq/storybook-addon-contributors
• Owner: mixmaxhq
• License: mit
• Created: 2019-03-02T20:58:26.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-11-21T07:57:15.000Z (about 1 year ago)
• Last Synced: 2025-01-09T11:58:09.987Z (about 1 month ago)
• Topics: storybook, storybook-addon, supported
• Language: JavaScript
• Homepage:
• Size: 612 KB
• Stars: 1
• Watchers: 6
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# storybook-addon-contributors

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

This is how Contributors look like:

![](docs/screenshot.png)

## 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).

```javascript

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

```

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

```javascript

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.

```javascript

Button.contributors = [

  {

    name: 'Andy Tran',

    url: 'https://github.com/andyhqtran',

  },

];

```