React Figma

⚛️ A React renderer for Figma

Monthly Downloads: 0

Programming language: TypeScript

License: MIT License

Tags: Code Design     React     Figma    

Latest version: v0.1.17

README

React Figma

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

• 🍬 Compatible with react-native, react-sketchapp, react-primitives API.
• 🦄 Flexible layouts support with Yoga Layout.
• ♻️ Hydration and HMR support.
• ⚙️ Built on Figma Plugin API.
• 🚫 Is not a code generator.

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>
    );
};

Docs

• API Overview
  • render
  • Page
  • Frame
  • View
  • Text
  • Image
  • ...
• Styling
• Architecture

Examples

• [Basic](examples/basic)
  • [Basic + HMR](examples/basic-hmr)
• [Design system](examples/design-system)
• [Interactive](examples/interactive)
• [Data fetching](examples/fetching)
• [💅 styled-components](examples/styled-components)
• PrimerDemo - Example of multiplatform UI-kit
• [Component Variants](examples/component-variants)
• [MDX](examples/mdx)
• [Local Styles](examples/local-styles)

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](./contributing.md) 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:

• Lera Lesik, for creating project logo.
• Maksim, for TypeScript counseling.

Tested with browserstack

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> Ilya Lesik💻 Losev Yaroslav💻 Vishnu Singh💻 corrina💻 Zachary Witt💻 Abdelrahman Ashraf💻 sprashad📖 Vivian Lee💻 macintoshhelper💻 Pierre Grimaud📖 Greg Westneat💻 Marius Reimer💻 szeko💻 Jonathan Holmes📖 不吃猫的鱼💻 Darío Hereñú📖 Konstantin Popov📖

<!-- markdownlint-restore --> <!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

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