pantoken-root / design/figma/src / toFigmaVariables

Function: toFigmaVariables()

toFigmaVariables(tokens, options?): FigmaVariablesPayload

Experimental

Convert an IR token list into a Figma Variables payload.

Parameters

tokens

readonly Token[]

The IR (e.g. from @pantoken/tokens).

options?

ToFigmaOptions = {}

ToFigmaOptions.

Returns

FigmaVariablesPayload

A FigmaVariablesPayload.

Examples

Convert the token IR to a Variables payload

import { toFigmaVariables } from "@pantoken/figma";
import { tokens } from "@pantoken/tokens";

const payload = toFigmaVariables(tokens); // { collection, modes, variables }

Rename the collection and modes

import { toFigmaVariables } from "@pantoken/figma";
import { tokens } from "@pantoken/tokens";

const payload = toFigmaVariables(tokens, {
  collection: "Instructure Rebrand",
  modes: ["Light", "Dark"],
});