How to sync design tokens from Figma to React

At Specify, we want to help you work better as a product team. As a developer, one of your jobs is to implement design tokens in your codebase. And let's face it, manually updating design data is cumbersome.

Specify helps you collect design data from Figma and distribute it in the right format, in the right project, at the right time, and to top it all: automatically.

Let's see how to synchronize design tokens and assets from Figma to a React project.

We will pull design data from the following Specify repository:

The Specify repository we'll pull our design data from.

We will generate the following files:

Prerequisites

Before anything else, please make sure you have:

1. created a Specify account

2. collected design data from Figma to a Specify repository

The Specify API

Specify is a Design API.

You can pull design data from Specify through:

• The Specify REST API

• The Specify CLI

• Our native GitHub application

Using the CLI

The Specify CLI helps you get design tokens and assets from Specify right from the terminal or even in a CI/CD pipeline.

Here's a short video tutorial to help you use the CLI to generate assets and a theme compatible with React:

Installation

First of all, let's install the Specify CLI: yarn global add @specifyapp/cli.

Once the Specify CLI is installed, run the specify command. You should get the following menu:

Specify CLI menu

Configuration

Specify is flexible. It was designed to adapt to your needs and not the other way around. However you must configure Specify to get design tokens and assets that fit your needs.

We want:

• our design tokens to be pulled and transformed as CSS Custom Properties

• our icons and our font files to be pulled, converted and optimized

First, let's create a .specifyrc.json Specify configuration inside our project folder.

Instead of writing our configuration manually, let's use our Configuration Template for React.

We could copy the suggested .specifyrc.json (CLI) template inside our config file. However, we could use this template right from the CLI thanks to the specify init command.

This command helps you setup a Specify configuration file right from the CLI:

1. You either choose to use a dedicated configuration template or start from scratch

2. You choose your template

3. You choose your configuration format (.js or .json)

Finalizing the configuration

Our configuration is almost done but we still need to change a couple of things:

1. We must set the Specify repository we're pulling design data from. In our case we're pulling design data from the all-design-data repository created in the @acme-inc organization.

2. We must generate a new personal access token and set it in the personalAccessToken property

Need help to generate your personal access token? Check this article.

Our final configuration is:

{
  "repository": "@acme-inc/all-design-data",
  "personalAccessToken": "1518676e8cb6a7d5f909acdaa59a00ae9d1f72263e49d1211a52e6303f7f2ece",
  "rules": [
    {
      "name": "Design Tokens / Theme",
      "path": "./output/styles/theme.js",
      "filter": {
        "types": [
          "color",
          "font",
          "textStyle"
        ]
      },
      "parsers": [
        {
          "name": "sort-by",
          "options": {
            "keys": [
              "name"
            ]
          }
        },
        {
          "name": "px-to-rem",
          "options": {
            "keys": [
              "fontSize"
            ]
          }
        },
        {
          "name": "to-theme-ui",
          "options": {
            "variants": true,
            "formatConfig": {
              "exportDefault": true
            },
            "formatTokens": {
              "colorFormat": {
                "format": "hsl"
              },
              "fontSizeFormat": {
                "type": "string",
                "unit": "rem"
              }
            },
            "presets": {
              "fontWeights": {
                "preset": "base",
                "freeze": true
              }
            }
          }
        }
      ]
    },
    {
      "name": "Design Tokens / CSS font imports",
      "path": "./output/styles/fonts.css",
      "filter": {
        "types": [
          "font"
        ]
      },
      "parsers": [
        {
          "name": "to-css-font-import",
          "options": {
            "formats": [
              "woff2",
              "woff"
            ],
            "fontsPath": "../assets/fonts"
          }
        }
      ]
    },
    {
      "name": "Design Tokens / Export fonts",
      "path": "./output/assets/fonts",
      "filter": {
        "types": [
          "font"
        ]
      },
      "parsers": [
        {
          "name": "convert-font",
          "options": {
            "formats": [
              "woff2",
              "woff"
            ]
          }
        }
      ]
    },
    {
      "name": "Icons",
      "path": "./output/assets/icons",
      "filter": {
        "types": [
          "vector"
        ]
      },
      "parsers": [
        {
          "name": "replace-string",
          "options": {
            "keys": [
              "name"
            ],
            "regex": {
              "pattern": "(.*?)\\/",
              "flags": "g"
            },
            "trim": true
          }
        },
        {
          "name": "kebabcasify"
        },
        {
          "name": "svgo",
          "options": {
            "svgo": {
              "js2svg": {
                "pretty": true
              }
            }
          }
        },
        {
          "name": "name-assets-files-by-pattern",
          "options": {
            "pattern": "{{name}}.jsx"
          }
        },
        {
          "name": "svg-to-jsx",
          "options": {
            "prepend": "import React from 'react';",
            "variableFormat": "camelCase",
            "wrapper": {
              "tag": "div",
              "className": "icon-{{name}} icon"
            }
          }
        }
      ]
    }
  ]
}

This configuration is now ready to be executed.

Let's run it by executing: specify pull.

The pull command helps you pull design data from the Specify repository you set in the repository property of your configuration. It tells Specify to read and execute your configuration and so it can generate design tokens and assets in your project.

Using the GitHub app

The Specify GitHub app helps you distribute your design tokens and assets from your Specify repository to your GitHub repositories. Every change detected in your Specify repository creates a Pull Request in your GitHub repositories.

How to do this:

1. Head over to your Specify repository you want to pull design data from

2. Go to your repository Destinations page

3. Add a Destination

4. Select GitHub app

5. Select your GitHub account and your GitHub repository

6. Select the "React" template

7. Create the Pull Request

8. Merge the Pull Request on GitHub

9. A new Pull Request containing your design data is created 🎉

Let's sum things up

We've learned how to synchronize our design tokens and assets from Figma to our project.

We've used the React Configuration Template in two ways:

• with the Specify CLI to pull design data in a local directory

• with the Specify GitHub app to pull design data in our GitHub repository

Don't see the configuration template you're looking for? Feel free to request a template ↗.