Designs Addon | Storybook: Frontend workshop for UI development

Designs

Storybook addon for embedding your design preview in addon panel

npm install storybook-addon-designs

Last updated 9 months ago

568.7k

Downloads per week

Readme View on GitHub

storybook-addon-designs

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

Docs & Demo

Requirements

Storybook@>=6.4.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
# yarn add -D storybook-addon-designs

To install v7 beta, use below command instead.

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

2. Register the addon in `main.js`

module.exports = {
  addons: ["storybook-addon-designs"],
};

3. Add it to story!

export default {
  title: "My stories",
  component: Button,
};

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

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