1.0.1 • Published 4 years ago

@dreipol/storybook-figma-addon v1.0.1

Weekly downloads
71
License
MIT
Repository
-
Last release
4 years ago

Description

Figma storybook addon to embed private and public figma projects. This addon was designed and tested only in a react environment.

Build Status NPM downloads NPM version Code quality MIT License

Installation

npm i @dreipol/storybook-figma-addon storybook-addon-designs -D

Usage

  1. Register the plugin in addons.js
    import '@dreipol/storybook-figma-addon/register';
  2. Set your figma project id and API token

    import { addDecorator } from '@storybook/react';
    import { withFigma } from '@dreipol/storybook-figma-addon';
    
    addDecorator(withFigma({
        apiToken: process.env.FIGMA_API_TOKEN,
        projectID: process.env.FIGMA_PROJECT_ID,
    }));
  3. Use it in your component stories

    stories.add(
        'Default',
        () => <ComponentExample/>,
        {
            // one or more figma image ids concatenated via commas
          figma: { 
             ids: '14%3A160,45%3A1939',
             names: ['Buttons', 'Buttons Hover']
          },
        },
    );