Skip to content

Theemo / @theemo/figma / FigmaToken

Interface: FigmaToken<T> ​

Defined in: figma/src/token.ts:10

The FigmaToken used in the figmaReader.

Extends the Token from @theemo/token with additional Figma properties

Extends ​

  • Token<T>

Type Parameters ​

Type ParameterDefault type
T extends TokenType"unknown"

Properties ​

description? ​

ts
optional description?: string;

Defined in: tokens/dist/index.d.ts:357

The description for the token

See ​

Design Tokens Format Module

Inherited from ​

ts
Token.description

figma ​

ts
figma: object;

Defined in: figma/src/token.ts:14

The extended Figma properties

file ​

ts
file: GetFileResult;

The file from where the token was sourced

node? ​

ts
optional node?: Node;

The respective node at which the token was found

style? ​

ts
optional style?: Style;

The related Style node the token was found

variable? ​

ts
optional variable?: FigmaVariable;

The related FigmaVariable the token token was found


name ​

ts
name: string;

Defined in: tokens/dist/index.d.ts:351

The tokens name

See ​

Inherited from ​

ts
Token.name

type? ​

ts
optional type?: keyof TokenTypeRegistry | T;

Defined in: tokens/dist/index.d.ts:369

The type helps token translation tools to generate the respective value in the appropriate format.

Remarks ​

Resources:

See ​

Inherited from ​

ts
Token.type

value? ​

ts
optional value?: `{${string}}` | ValueFor<T>;

Defined in: tokens/dist/index.d.ts:379

The tokens computed value

Remarks ​

References:

See ​

DTCG Glossary (Design Token Value)

Inherited from ​

ts
Token.value