Installation

Using package manager

# npm
npm install @iconsync/core
 
# yarn
yarn add @iconsync/core
 
# pnpm
pnpm add @iconsync/core

Setting up your configuration

Create an icon.config.ts file in your project root:

import { iconConfig } from "@iconsync/core";
 
export default iconConfig({
  figma: {
    token: process.env.FIGMA_TOKEN!, // Your Figma API token
    url: "https://www.figma.com/design/YOUR_FILE_ID/YOUR_FILE_NAME?node-id=YOUR_NODE_ID",
  },
  fetch: {
    concurrentDownloads: 5,
  },
  generator: {
    icon: true,
    typescript: true,
    outDir: "src/components/icons",
    ext: "tsx",
    prettier: true,
  },
});

Adding scripts to package.json

Add these scripts to your package.json:

{
  "scripts": {
    "icon:fetch": "iconsync fetch",
    "icon:cache:stats": "iconsync cache:stats",
    "icon:cache:clear": "iconsync cache:clear",
    "icon:generate": "iconsync generator"
  }
}

Setting up your Figma token

Create a .env file and add your Figma token:

FIGMA_TOKEN=your_figma_api_token

You can obtain a Figma API token from your Figma account settings under the "Personal access tokens" section.

Introduction Usage