to-css-custom-properties
This parser helps you transform design tokens into CSS Custom Properties.
Interface
interface parser {
name: 'to-css-custom-properties';
output: {
type: 'file';
filePath: string;
};
options?: {
tokenNameTemplate?: string;
selectorTemplate?: string;
includeCoreTokensInScopes?: boolean;
};
}
Options
selectorTemplate
optional
string
The pattern used to generate the CSS selector name(s). It must match mustache template syntax.
You can use collection
, mode
and groups
names.
tokenNameTemplate
optional
string
The pattern used to generate token names. It must match mustache template syntax.
You can use collection
, mode
,groups
and token
names.
includeCoreTokensInScopes
optional
boolean
false
When set to true
, you will have both core tokens and alias tokens in each CSS scopes thus making alias tokens always resolvable.
Basic usage
A design token can have modes, be nested in groups and be part of a collection. The following use case will generate a single CSS file containing core tokens and semantic tokens.
{
"colors": {
"$collection": { "$modes": ["Light", "Dark"] },
"core": {
"blue-100": {
"$type": "color",
"$description": "token 1 aliased with n modes within collection within n groups",
"$value": {
"Light": {
"red": 219,
"blue": 254,
"alpha": 1,
"green": 236,
"model": "rgb"
},
"Dark": {
"red": 41,
"blue": 67,
"alpha": 1,
"green": 52,
"model": "rgb"
}
}
},
"blue-700": {
"$type": "color",
"$description": "token 2 aliased with n modes within collection within n groups",
"$value": {
"Light": {
"red": 17,
"blue": 249,
"alpha": 1,
"green": 125,
"model": "rgb"
},
"Dark": {
"red": 96,
"blue": 250,
"alpha": 1,
"green": 168,
"model": "rgb"
}
}
}
},
"semantic": {
"background": {
"button": {
"primary": {
"hover": {
"$type": "color",
"$description": "alias token with n modes within collection within n groups",
"$value": {
"Dark": {
"$mode": "Dark",
"$alias": "colors.core.blue-100"
},
"Light": {
"$mode": "Light",
"$alias": "colors.core.blue-700"
}
}
}
}
}
}
}
}
}
Last updated
Was this helpful?