Types

Type Aliases

BaseProperties

type BaseProperties = object;

Properties

$description?
optional $description: string;
$extensions?
optional $extensions: Record<string, any>;

BorderToken

type BorderToken = BaseProperties & object;

Type declaration

NameType
$type?"border"
$value| { color: ColorToken["$value"]; style: StrokeStyleToken["$value"]; width: DimensionToken["$value"]; } | ReferenceValue

ColorToken

type ColorToken = BaseProperties & object;

Type declaration

NameType
$type?"color"
$value`#${string}` | ReferenceValue

Config

type Config = object;

Properties

data
data: string | string[] | object | object[];
options?
optional options: ConfigOptions;

ConfigOptions

type ConfigOptions = object;

Properties

customValidator?
optional customValidator: ValidatorConfig;
loader
loader: Loader | string;
platforms
platforms: Platform[];
validator()?
optional validator: (value, config?) => ValidatorReturn;
Parameters
ParameterType
valueunknown
config?ValidatorConfig
Returns

ValidatorReturn

CubicBezierToken

type CubicBezierToken = BaseProperties & object;

Type declaration

NameType
$type?"cubicBezier"
$value| [number | ReferenceValue, number | ReferenceValue, number | ReferenceValue, number | ReferenceValue] | ReferenceValue

DimensionToken

type DimensionToken = BaseProperties & object;

Type declaration

NameType
$type?"dimension"
$value| { unit: "px" | "rem"; value: number; } | ReferenceValue

DurationToken

type DurationToken = BaseProperties & object;

Type declaration

NameType
$type?"duration"
$value| { unit: "ms" | "s"; value: number; } | ReferenceValue

FontFamilyToken

type FontFamilyToken = BaseProperties & object;

Type declaration

NameType
$type?"fontFamily"
$value| string | (string | ReferenceValue)[] | ReferenceValue

FontWeightToken

type FontWeightToken = BaseProperties & object;

Type declaration

NameType
$type?"fontWeight"
$valuestring | number | ReferenceValue

GradientToken

type GradientToken = BaseProperties & object;

Type declaration

NameType
$type?"gradient"
$value| ( | { color: ColorToken["$value"]; position: NumberToken["$value"]; } | ReferenceValue)[] | ReferenceValue

LooseToken

type LooseToken = ModifyProperties<Token, {
  $type: string;
  $value: any;
}>;

NumberToken

type NumberToken = BaseProperties & object;

Type declaration

NameType
$type?"number"
$valuenumber | ReferenceValue

Platform

type Platform = object;

Properties

config?
optional config: any;
format
format: Format | string;
name
name: string;
outputs
outputs: object[];
fileHeader?
optional fileHeader: FileHeader;
filter()?
optional filter: ({ token, path }) => boolean;
Parameters
ParameterType
{ token, path }{ path: string; token: Token; }
{ token, path }.pathstring
{ token, path }.tokenToken
Returns

boolean

name
name: string;
transforms?
optional transforms: (string | Transform | TransformGroup)[];

PlatformWithoutString

type PlatformWithoutString = ModifyProperties<Platform, {
  format: Format;
  transforms: (Transform | TransformGroup)[];
}>;

ReferenceValue

type ReferenceValue = `{${string}}`;

ShadowToken

type ShadowToken = BaseProperties & object;

Type declaration

NameType
$type?"shadow"
$valueShadowValue | ShadowValue[] | ReferenceValue

StrictToken

type StrictToken = WithRequired<Token, "$type">;

StrokeStyleToken

type StrokeStyleToken = BaseProperties & object;

Type declaration

NameType
$type?"strokeStyle"
$value| typeof strokePredefinedValues[number] | { dashArray: DimensionToken["$value"][]; lineCap: typeof lineCapPredefinedValues[number]; } | ReferenceValue

Token

type Token = 
  | ColorToken
  | DimensionToken
  | FontFamilyToken
  | FontWeightToken
  | DurationToken
  | CubicBezierToken
  | NumberToken
  | TransitionToken
  | ShadowToken
  | GradientToken
  | TypographyToken
  | StrokeStyleToken
  | BorderToken;

TokenCompositeValue

type TokenCompositeValue = Exclude<
  | TypographyToken["$value"]
  | ShadowToken["$value"]
  | GradientToken["$value"]
  | TransitionToken["$value"]
  | StrokeStyleToken["$value"]
| BorderToken["$value"], ReferenceValue>;

TokenGroup

type TokenGroup = TokenGroupProperties & object;

TokenGroupProperties

type TokenGroupProperties = object;

Properties

$description?
optional $description: string;
$extensions?
optional $extensions: object;
$type?
optional $type: TokenType;

TokenType

type TokenType = Exclude<Token["$type"], undefined>;

TokenValue

type TokenValue = Token["$value"];

TransitionToken

type TransitionToken = BaseProperties & object;

Type declaration

NameType
$type?"transition"
$value| { delay: DurationToken["$value"]; duration: DurationToken["$value"]; timingFunction: CubicBezierToken["$value"]; } | ReferenceValue

TypographyToken

type TypographyToken = BaseProperties & object;

Type declaration

NameType
$type?"typography"
$value| { fontFamily: FontFamilyToken["$value"]; fontSize: DimensionToken["$value"]; fontWeight: FontWeightToken["$value"]; letterSpacing: DimensionToken["$value"]; lineHeight: NumberToken["$value"]; } | ReferenceValue

Functions

defineConfig()

function defineConfig(config): Config;

Define a configuration object for the design token builder. It should be used with CLI.

Parameters

ParameterType
configConfig

Returns

Config