@primer/figma-action
v1.0.0-alpha.3
Published
GitHub action for exporting figma components.
Downloads
15
Readme
GitHub action for exporting Figma components
A GitHub action that will export Figma components from design files to your repository.
Usage
Example workflow
name: Export SVG from Figma
on: [push]
jobs:
all:
name: Figma Export
runs-on: ubuntu-latest
steps:
- uses: primer/[email protected]
with:
args: "format=svg outputDir=./build/"
env:
FIGMA_FILE_URL: "https://www.figma.com/file/ZFjrph2HUwFK8Q3uEtJIu1PT/yourfilename"
FIGMA_TOKEN: ${{ secrets.FIGMA_TOKEN }}
Variables
Secrets
FIGMA_TOKEN
(required)
This token is used to access the Figma API. It's required to generate one so this action will work. It's recommended to set the token in a secret token in your repository.
env variables
FIGMA_FILE_URL
(required)
This is the file url that you would like to export from. The action will search the file for components and export them with your configurations.
Workflow args (optional)
format
– The export format for exporting from Figma. Options aresvg
,jpg
,png
. Default isjpg
outputDir
– Where you would like the exported files to live. Default is./build/
scale
– When choosing an image formatjpg
orpng
this is the export scale between0.01
and4
that will allow you to scale the image. Default is1
.
Output
The output of this action lives in ./build/
by default, but can be configured. In addition to the files exported you will see a data.json
file exported. This contains information about the exported components mapped by component id
.
The directory will look like this:
./outputDir/
├── format/
| └── componentName.format
└── data.json
The data.json file will look like this:
{
"0:639": {
"name": "plus", // component name
"id": "0:639", // component figma id
"key": "89696b0b52493acc8692546ac829bd4e334c63a2", // component global figma id
"file": "FP7lqd1V00LUaT5zvdklkkZr", // figma file key
"description": "keywords: add, new, more", // figma component description
"width": 12, // width of the component frame
"height": 16, // height of the component frame
"image": "https://s3-us-west-2.amazonaws.com/figma-alpha-api/img/1/6d/1234" // aws URL for the exported file
}
}