register-view
This parser helps you register a SDTF view that can be later used by generation parser to allow for partial outputs of the token tree with no destructive mutations.
Interface
interface parser {
name: 'register-view';
options: {
name: string;
query: SDTFQuery;
};
}Options
Parameter
Required
Type
Default
Description
name
true
string
The name of the SDTF view.
Basic usage: register a SDTF view for use with CSS output
{
"colors": {
"$collection": {
"$modes": ["light", "dark"]
},
"info": {
"infoToken": {
"$type": "color",
"$value": {
"light": {
"model": "rgb",
"red": 219,
"green": 234,
"blue": 254,
"alpha": 1
},
"dark": {
"model": "rgb",
"red": 219,
"green": 234,
"blue": 254,
"alpha": 1
}
}
}
},
"danger": {
"dangerToken": {
"$type": "color",
"$value": {
"light": {
"model": "rgb",
"red": 209,
"green": 204,
"blue": 204,
"alpha": 1
},
"dark": {
"model": "rgb",
"red": 19,
"green": 34,
"blue": 54,
"alpha": 1
}
}
}
}
}
}We want to get all tokens in all groups named "info"
We also want to get the
parentcollection...... and all
childrentokens within the "info" group(s)We eventually generate our selected SDTF token tree in a CSS file thanks to the
to-css-custom-propertiesparser.
Last updated
Was this helpful?