@auth0/quantum-icons v1.0.0

Quantum Icons

Installation

To install Quantum Icons, use the following Yarn command:

yarn add @auth0/quantum-icons

Export Icons from Figma

Identifying Environment Variables

Before exporting icons from Figma and updating Quantum Icons, you need to create an .env file with the following configurations:

FIGMA_PROJECT_ID=<project-id>
FIGMA_PROJECT_NODE_ID=<project-node-id>
FIGMA_API_KEY=<personal-figma-token>

To obtain these configurations, follow these steps: 1. In your Figma project, the URL will resemble the following: https://www.figma.com/file/abcdprojectid/project-name?type=design&node-id=1428-39 2. In this scenario, your .env variables would be:

FIGMA_PROJECT_ID=abcdprojectid
FIGMA_PROJECT_NODE_ID=1428:39
FIGMA_API_KEY=<personal-figma-token>

To obtain the access token, follow these steps:

1. Go to Figma in the browser.
2. Navigate to Account Settings -> Account Tab.
3. Scroll down to Personal access tokens.
4. Generate a token and copy it.

Running the Export Script

Once you have all environment configurations set up, use the following command to update/pull icons from Figma:

yarn export-figma-icons

This command will update all Figma icons with the new exports to the ./src/svg folder.