Skip to content
On this page

Figma Configs

Figma configs are where you can define figma settings for Figus. Figma configs define fundamental settings that are required in order to integrate with Figma's REST API

export default {
    // These are figma level configs.
    ...,
    figma: {
        pageName: "Icon",
        fileKey: "fileKey",
        token: "figma token"
    },
    ...
}

pageName

  • Type: string
  • Required: false

The page name where the icons library sits in Figma. See how to find that information in Figma Optional as some of Figma pages have only icons, so no need to filter by page name Try first without page name and if there are too many icons or no icons at all, add the page name.

export default {
  figma: {
      pageName: "Icons"
  }
}

fileKey

  • Type: string
  • Required: true

The file key name where the icons library sits in Figma. See how to find that information in Figma

export default {
  fileKey: 'ddk2DXkqwyZ'
}

token

  • Type: string
  • Required: true

We must have a Figma token to integrate with the API, to get a new token, follow these instructions Login to Figma, then you can click on Get personal access token

export default {
  token: 'figd_5zdkzZdv9evo00akdUGxapz90rJdf_HmZ1AiMVTt'
}

Released under the MIT License.