/storybook-addon-designs

A Storybook addon that embed Figma, websites, PDF or images in the addon panel.

Primary LanguageTypeScriptMIT LicenseMIT

logo

npm version Monthly download GitHub license code style: prettier

storybook-addon-designs

A Storybook addon that embed Figma or websites in the addon panel for better design-development workflow.

Requirements

  • Storybook@>=5.0.0

This addon should work well with any framework: If you find the case the addon not works, please open an issue.

Getting started

1. Install

npm install --save-dev storybook-addon-designs@alpha
# yarn add -D storybook-addon-designs@alpha

2. Register the addon in main.js

// .storybook/main.js
module.exports = {
  addons: ['storybook-addon-designs'],
}

3. Add it to story!

import { withDesign } from 'storybook-addon-designs'

export default {
  title: 'My stories',
  component: Button,
  decorators: [withDesign],
}

export const myStory = () => <Button>Hello, World!</Button>

myStory.parameters = {
  design: {
    type: 'figma',
    url: 'https://www.figma.com/file/LKQ4FJ4bTnCSjedbRpk931/Sample-File',
  },
}

Similar projects