Figma-export-colors NPM

figma-export-colors

Command line script to generate a .js or .ts colors object from the generated colors using tailwind-css-color-generator that you can spread in your tailwind.config file.

Features

Export all the color variables from figma into your codebase with a single command.

Installation

Install the cli globally so you can use it on any directory

npm install -g figma-export-colors

Or if you prefer install it in your project

npm install -D figma-export-colors

Usage

Create a figma-export-config.json file in the root directory with the following structure

{
  "figmaPersonalToken": "YOUR_PERSONAL_TOKEN",
  // File id can be found in the url of the figma file
  // E.g https://www.figma.com/design/[FILE_ID]/
  "fileId": "FILE_ID",
  "colorsPage": "Colors",
  // The frame name in Figma page.
  // If is nested frame, could be referenced by slashes as path (/parenFrame/firstChildFrame/colorsChildFrame)
  "colorsFrame": "Empty or ColorFrameContainerName or ColorFrameContainerName/ChildFrame/...",
  "colorsExportDirectory": "./constants",
  "colorsExportFileName": "colors",
  "typescript": true,
}

If you have installed the module globally:

$ export-colors

If you have installed it locally:

Create a script in your package.json

scripts: {
 'export-colors': 'export-colors'
}

and run

npm run export-colors

run it directly with:

npx export-colors

Example of an exported file as colors.js

module.exports.colors = {
  black: "#000000",
  white: "#ffffff",
  yellow: {
    50: "#fdffe7",
    100: "#f9ffc1",
    200: "#f8ff86",
    // ...
  },
  purple: {
    50: "#f3f3ff",
    100: "#eae9fe",
    200: "#d8d6fe",
    // ...
  },
  // ...
};

Example of an exported file as colors.ts

export const colors = {
  black: "#000000",
  white: "#ffffff",
  yellow: {
    50: "#fdffe7",
    100: "#f9ffc1",
    200: "#f8ff86",
    // ...
  },
  purple: {
    50: "#f3f3ff",
    100: "#eae9fe",
    200: "#d8d6fe",
    // ...
  },
  // ...
};

In your tailwind.config you spread the exported colors object

import { colors } from "./constants/colors";

const config = {
  theme: {
    colors: {
      current: "currentColor",
      transparent: "transparent",
      ...colors,
    },
  },
};