Giter Club home page Giter Club logo

storybook-figma-addon's Introduction

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']
          },
        },
    );

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.