Create script that can sync Design Tokens to Figma Variables with Figma REST API

What does this MR do?

Creates a script that is able to sync Design Token JSON with Figma Variables using Figma REST API

Setup

1. Create Figma Collections

In your Figma file, create two variable collections:

  • Constants: Single mode called "value"
  • Mode: Two modes called "default" and "dark"

2. Generate Figma Token

  1. Go to https://www.figma.com/settings/tokens
  2. Create a new personal access token with these scopes:
    • file_content:read
    • file_variables:read
    • file_variables:write

3. Set Environment Variables

Create /packages/gitlab-ui/.figma.env file with contents:

export FIGMA_TOKEN="your_token_here"
export FIGMA_FILE_ID="your_file_id_here"

The file ID can be found in your Figma URL: figma.com/file/{FILE_ID}

Usage

# in /packages/gitlab-ui
yarn sync-tokens

Screenshots or screen recordings

n/a

Integrations

n/a

Does this MR meet the acceptance criteria?

This checklist encourages the authors, reviewers, and maintainers of merge requests (MRs) to confirm changes were analyzed for conformity with the project's guidelines, security and accessibility.

Toggle the acceptance checklist

Conformity

  • The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”.
    • For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
  • Relevant label(s) are applied to the MR.
  • The MR is added to a milestone.
  • Added the ~"component:*" label(s) if applicable.
  • A changeset is added when this MR will do a patch, minor, or major update. More information can be found in doc/publishing-packages.md.

Components

  • GitLab UI's contributing guidelines.
  • If the MR changes a component's API, integration MR(s) have been opened (see integrations above).

Documentation

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Dan MH

Merge request reports

Loading