Theemo / @theemo/figma / FigmaParserConfig
Interface: FigmaParserConfig
Defined in: packages/figma/src/config.ts:63
Configuration for Figma Parser
Properties
considerMode()?
optional considerMode: (mode) => boolean;Defined in: packages/figma/src/config.ts:155
Should this mode considered to be used for tokens?
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | string | the name of the mode |
Returns
boolean
true, when the mode is used for tokens
See
formats?
optional formats: ColorConfig;Defined in: packages/figma/src/config.ts:206
The formats in which tokens are written to disk
getConstraints()?
optional getConstraints: (mode, variable) =>
| undefined
| Partial<FeatureConstraints & ScopeConstraint>;Defined in: packages/figma/src/config.ts:166
Returns the constraints for a considered mode
Parameters
| Parameter | Type | Description |
|---|---|---|
mode | string | the name of the mode |
variable | FigmaVariable | Figma Variable |
Returns
| undefined | Partial<FeatureConstraints & ScopeConstraint>
the constraints for the given mode
See
getNameFromStyle()?
optional getNameFromStyle: (style) => string;Defined in: packages/figma/src/config.ts:87
To retrieve the name for a token from a Style
Parameters
| Parameter | Type | Description |
|---|---|---|
style | Style | Figma Style |
Returns
string
the name for the given style
See
getNameFromText()?
optional getNameFromText: (node) => string;Defined in: packages/figma/src/config.ts:112
To retrieve the name for a token from a Node
Parameters
| Parameter | Type | Description |
|---|---|---|
node | Node<"TEXT"> | Figma Text Node |
Returns
string
the token name for the text node
See
getNameFromVariable()?
optional getNameFromVariable: (variable) => string;Defined in: packages/figma/src/config.ts:146
Retrieve the token name for the given variable
Parameters
| Parameter | Type | Description |
|---|---|---|
variable | FigmaVariable | Figma Variable |
Returns
string
the token name for the variable
See
getPropertiesForToken()?
optional getPropertiesForToken: (token, document) => Record<string, unknown>;Defined in: packages/figma/src/config.ts:201
Add properties relevant for you to the token.
Parameters
| Parameter | Type | Description |
|---|---|---|
token | FigmaToken | Figma Token |
document | GetFileResult | The Figma File from which this token was sourced |
Returns
Record<string, unknown>
an object with properties
See
getTypeFromToken()?
optional getTypeFromToken: (token) => keyof TokenTypeRegistry;Defined in: packages/figma/src/config.ts:191
When the type of a token was detected incorrectly or is missing for some other reasons, here is a chance to provide it
Parameters
| Parameter | Type | Description |
|---|---|---|
token | FigmaToken | Figma Token |
Returns
keyof TokenTypeRegistry
the type of a token
See
getValueFromText()?
optional getValueFromText: (node) => unknown;Defined in: packages/figma/src/config.ts:122
To retrieve the value for a token from a Node
Parameters
| Parameter | Type | Description |
|---|---|---|
node | Node<"TEXT"> | Figma Text Node |
Returns
unknown
the token value of that text node
See
isTokenByStyle()?
optional isTokenByStyle: (style) => boolean;Defined in: packages/figma/src/config.ts:77
This is to verify that a given Style node found in figmas node tree is considered to be a token or not
Parameters
| Parameter | Type | Description |
|---|---|---|
style | Style | Figma Style |
Returns
boolean
true, when this style should be considered a token
See
isTokenByText()?
optional isTokenByText: (node) => boolean;Defined in: packages/figma/src/config.ts:102
This is to verify that a given Nodefound in figmas node tree is considered to be a token or not, depending on the name of the node
Parameters
| Parameter | Type | Description |
|---|---|---|
node | Node<"TEXT"> | Figma Text Node |
Returns
boolean
true, when this text node should be considered a token
See
isTokenByVariable()?
optional isTokenByVariable: (variable) => boolean;Defined in: packages/figma/src/config.ts:136
Should this variable be considered a token, or not?
Parameters
| Parameter | Type | Description |
|---|---|---|
variable | FigmaVariable | Figma Variable |
Returns
boolean
true, when this variable is considered to be atoken
See
skipTypeForReferences?
optional skipTypeForReferences: boolean;Defined in: packages/figma/src/config.ts:177
Skip type for tokens that are references.
According to the spec, $type can be optional when certain criteria are met. One of them being references. If you wish, you can skip types here.
See
Default
false