Render React components to Figma


Keywords
figma, react, figma-plugins
License
MIT
Install
npm install react-figma@0.10.0

Documentation

React Figma

React Figma logo by Lera Lesik

npm version CircleCI

A React renderer for Figma. Use React components as a source for your designs.

Example of code:

import * as React from 'react';
import { Page, View, Text } from 'react-figma';

export const App = () => {
    return (
        <Page name="New page" isCurrent>
            <View>
                <View style={{ width: 200, height: 100, backgroundColor: '#dd55aa' }} />
                <Text style={{ color: '#ffffff' }}>text</Text>
            </View>
        </Page>
    );
};

Installation

Using boilerplate

You can use react-figma-boilerplate for creating own projects.

From scratch

Install it with yarn:

yarn add react react-figma

Or with npm:

npm i react react-figma --save

Usage

Configure main thread

import { setupMainThread } from 'react-figma/rpc';

figma.showUI(__html__, { visible: false });

setupMainThread();

Configure ui thread

import * as React from 'react';
import { App } from './App';

import 'react-figma/rpc';
import { render } from 'react-figma';

render(<App />);

Import components

import * as React from 'react';
import { Page, Rectangle, Text } from 'react-figma';

export const App = () => {
    return (
        <Page name="New page">
            <Rectangle style={{ width: 200, height: 100, backgroundColor: '#dd55aa' }} />
            <Text characters="text" style={{ color: '#ffffff' }} />
        </Page>
    );
};

Examples

Sponsoring

Become a backer and get your logo on our Readme on GitHub with a link to your site.

Become a sponsor and get your logo on our README on GitHub with a link to your site.

Contributing

Everyone is welcome to contribute. Whether you're helping us implement features, fix bugs or improve the docs, we'd love to have you as part of the community!

How to Contribute

Check out our Contributing Guide for ideas on contributing and setup steps for getting repository up and running on your local machine.

Acknowledgements

React Figma team wishes to thank the following invaluable contributions:

Tested with browserstack

Tested with browserstack

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Ilya Lesik
Ilya Lesik

💻
Losev Yaroslav
Losev Yaroslav

💻
Vishnu Singh
Vishnu Singh

💻
corrina
corrina

💻
Zachary Witt
Zachary Witt

💻
Abdelrahman Ashraf
Abdelrahman Ashraf

💻
sprashad
sprashad

📖
Vivian Lee
Vivian Lee

💻
macintoshhelper
macintoshhelper

💻
Pierre Grimaud
Pierre Grimaud

📖
Greg Westneat
Greg Westneat

💻
Marius Reimer
Marius Reimer

💻
szeko
szeko

💻
Jonathan Holmes
Jonathan Holmes

📖
不吃猫的鱼
不吃猫的鱼

💻
Darío Hereñú
Darío Hereñú

📖
Konstantin Popov
Konstantin Popov

📖
Utkarsh Singh
Utkarsh Singh

📖
mrkenneh
mrkenneh

💻
Anna Do
Anna Do

💻
Steven Petryk
Steven Petryk

💻
Thierry Charbonnel
Thierry Charbonnel

📖
Jack Oliver
Jack Oliver

📖
Marc Abramowitz
Marc Abramowitz

📖
fishtriangle
fishtriangle

💻
Carlos
Carlos

📖

This project follows the all-contributors specification. Contributions of any kind welcome!