@terrazzo/token-tools
Version:
Various utilities for token types
158 lines (155 loc) • 6.76 kB
TypeScript
import { BooleanTokenNormalized, BorderTokenNormalized, ColorTokenNormalized, CubicBezierTokenNormalized, DimensionTokenNormalized, DurationTokenNormalized, FontFamilyTokenNormalized, FontWeightTokenNormalized, GradientTokenNormalized, LinkTokenNormalized, NumberTokenNormalized, ShadowTokenNormalized, ShadowValueNormalized, StringTokenNormalized, StrokeStyleTokenNormalized, TokenNormalized, TokenNormalizedSet, TransitionTokenNormalized, TypographyTokenNormalized } from "./types-BOWDcBsq.js";
//#region src/css/lib.d.ts
/** Function that generates a var(…) statement */
type IDGenerator<T = TokenNormalized> = (token: T) => string;
declare function defaultAliasTransform(token: TokenNormalized): string;
/** Generate shorthand CSS for select token types */
declare function generateShorthand({
$type,
localID
}: {
$type: string;
localID: string;
}): string | undefined;
interface MakeCSSVarOptions {
/** Prefix with string */
prefix?: string;
/**
* Wrap with `var(…)`
* @default false
*/
wrapVar?: boolean;
}
/**
* Generate a valid CSS variable from any string
* Code by @dfrankland
*/
declare function makeCSSVar(name: string, {
prefix,
wrapVar
}?: MakeCSSVarOptions): string;
//# sourceMappingURL=lib.d.ts.map
//#endregion
//#region src/css/css-types.d.ts
interface TransformCSSValueOptions {
/** Complete set of tokens (needed to resolve full and partial aliases) */
tokensSet: TokenNormalizedSet;
transformAlias?: IDGenerator;
/** Options for color tokens */
color?: {
/** Output legacy hex-6 and hex-8 */
legacyHex?: boolean;
};
}
//# sourceMappingURL=css-types.d.ts.map
//#endregion
//#region src/css/color.d.ts
type WideGamutColorValue = {
'.': string;
srgb: string;
p3: string;
rec2020: string;
};
/** Convert color value to CSS string */
declare function transformColor(token: ColorTokenNormalized, options: TransformCSSValueOptions): string | WideGamutColorValue;
//# sourceMappingURL=color.d.ts.map
//#endregion
//#region src/css/boolean.d.ts
/** Convert boolean value to CSS string */
declare function transformBoolean(token: BooleanTokenNormalized, {
tokensSet,
transformAlias
}: TransformCSSValueOptions): string;
//# sourceMappingURL=boolean.d.ts.map
//#endregion
//#region src/css/border.d.ts
/** Convert border value to multiple CSS values */
declare function transformBorder(token: BorderTokenNormalized, options: TransformCSSValueOptions): string | {
'.': string;
srgb: string;
p3: string;
rec2020: string;
};
//# sourceMappingURL=border.d.ts.map
//#endregion
//#region src/css/cubic-bezier.d.ts
/** Convert cubicBezier value to CSS */
declare function transformCubicBezier(token: CubicBezierTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=cubic-bezier.d.ts.map
//#endregion
//#region src/css/dimension.d.ts
/** Convert dimension value to CSS */
declare function transformDimension(token: DimensionTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=dimension.d.ts.map
//#endregion
//#region src/css/duration.d.ts
/** Convert duration value to CSS */
declare function transformDuration(token: DurationTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=duration.d.ts.map
//#endregion
//#region src/css/font-family.d.ts
declare function transformFontFamily(token: FontFamilyTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=font-family.d.ts.map
//#endregion
//#region src/css/font-weight.d.ts
/** Convert fontWeight value to CSS */
declare function transformFontWeight(token: FontWeightTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=font-weight.d.ts.map
//#endregion
//#region src/css/gradient.d.ts
/** Convert gradient value to CSS */
declare function transformGradient(token: GradientTokenNormalized, options: TransformCSSValueOptions): string | WideGamutColorValue;
//# sourceMappingURL=gradient.d.ts.map
//#endregion
//#region src/css/link.d.ts
/** Convert link value to CSS */
declare function transformLink(token: LinkTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=link.d.ts.map
//#endregion
//#region src/css/number.d.ts
/** Convert number value to CSS */
declare function transformNumber(token: NumberTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=number.d.ts.map
//#endregion
//#region src/css/shadow.d.ts
/** Convert shadow subvalue to CSS */
declare function transformShadowLayer(value: ShadowValueNormalized, options: TransformCSSValueOptions & {
colorValue: string;
partialAliasOf?: Partial<Record<keyof typeof value, string>>;
}): string | Record<string, string>;
/** Convert shadow value to CSS */
declare function transformShadow(token: ShadowTokenNormalized, options: TransformCSSValueOptions): string | Record<string, string>;
//# sourceMappingURL=shadow.d.ts.map
//#endregion
//#region src/css/string.d.ts
/** Convert string value to CSS */
declare function transformString(token: StringTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=string.d.ts.map
//#endregion
//#region src/css/stroke-style.d.ts
/** Convert strokeStyle value to CSS */
declare function transformStrokeStyle(token: StrokeStyleTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=stroke-style.d.ts.map
//#endregion
//#region src/css/transition.d.ts
/** Convert transition value to shorthand */
declare function transformTransition(token: TransitionTokenNormalized, options: TransformCSSValueOptions): string;
//# sourceMappingURL=transition.d.ts.map
//#endregion
//#region src/css/typography.d.ts
/** Convert typography value to multiple CSS values */
declare function transformTypography(token: TypographyTokenNormalized, options: TransformCSSValueOptions): Record<string, string>;
//# sourceMappingURL=typography.d.ts.map
//#endregion
//#region src/css/index.d.ts
/** Main CSS Transform */
declare function transformCSSValue<T extends TokenNormalized = TokenNormalized>(token: T, {
mode,
...options
}: {
mode: keyof T['mode'];
} & TransformCSSValueOptions): string | WideGamutColorValue | Record<string, string> | undefined;
//# sourceMappingURL=index.d.ts.map
//#endregion
export { IDGenerator, MakeCSSVarOptions, WideGamutColorValue, defaultAliasTransform, generateShorthand, makeCSSVar, transformBoolean, transformBorder, transformCSSValue, transformColor, transformCubicBezier, transformDimension, transformDuration, transformFontFamily, transformFontWeight, transformGradient, transformLink, transformNumber, transformShadow, transformShadowLayer, transformString, transformStrokeStyle, transformTransition, transformTypography };
//# sourceMappingURL=css.d.ts.map