Class Tokens_CSS`Internal`

Generates a complete token object for the design system.

Since

0.1.0-alpha

Hierarchy (View Summary)

AbstractTokens<Tokens_CSS.Data>
- Tokens_CSS

Index

Constructors

constructor

new Tokens_CSS(input: Tokens_CSS.InputParam): Tokens_CSS
Internal
Parameters
- input: Tokens_CSS.InputParam
Returns Tokens_CSS
Overrides AbstractTokens.constructor
- Defined in 02-tokens/Tokens_CSS.ts:50

Properties

`Static` `Readonly` `Internal`tokenLevels

tokenLevels: readonly [
    "100",
    "200",
    "300",
    "400",
    "500",
    "600",
    "700",
    "800",
    "900",
] = ...

`Static` `Readonly` `Internal`tokenLevels_extraOptions

tokenLevels_extraOptions: readonly [
    "150",
    "250",
    "350",
    "450",
    "550",
    "650",
    "750",
    "850",
] = ...

`Readonly` `Internal`tokenLevels

tokenLevels: readonly [
    "100",
    "200",
    "300",
    "400",
    "500",
    "600",
    "700",
    "800",
    "900",
] = AbstractTokens.tokenLevels

`Protected` `Readonly` `Internal`border

border: Tokens_CSS_Border

`Protected` `Readonly` `Internal`style

style: Tokens_CSS_Style

`Protected` `Readonly` `Internal`transition

transition: Tokens_CSS_Transition

`Protected` `Readonly` `Internal`zIndex

zIndex: {
    nav: number;
    popup: number;
    settings: number;
    skipLink: number;
    [key: string]: number;
}

Accessors

`Static`default

get default(): Omit<Tokens_CSS.Data, "border" | "style" | "transition">
Internal
Returns Omit<Tokens_CSS.Data, "border" | "style" | "transition">
- Defined in 02-tokens/Tokens_CSS.ts:24

data

get data(): Tokens_CSS.Data
Internal
The value of this token.

Returns Tokens_CSS.Data
Since
0.1.0-alpha
Overrides AbstractTokens.data
- Defined in 02-tokens/Tokens_CSS.ts:36

Methods

`Static`customErrorMap

customErrorMap(
...params: [issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx],
): { message: string }
Internal
A custom error handler to use with Zod schemas.
Parameters
- ...params: [issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx]
Returns { message: string }
Since
0.1.0-alpha
Inherited from AbstractTokens.customErrorMap
- Defined in 02-tokens/abstract/AbstractTokens.ts:81

toJSON

toJSON(): Tokens_CSS.Data
Internal
Converts this token or group to a json-compatible object. NOT W3C tokens -- this is meant to be more human-readable.

Uses AbstractTokens.schemaJSON.

Returns Tokens_CSS.Data
Since
0.1.0-alpha
Overrides AbstractTokens.toJSON
- Defined in 02-tokens/Tokens_CSS.ts:62

toScss

toScss(): string
Internal
Uses AbstractTokens.toScssVars to convert this token to a scss string.

Returns string
Since
0.1.0-alpha
Inherited from AbstractTokens.toScss
- Defined in 02-tokens/abstract/AbstractTokens.ts:144

toScssVars

toScssVars(): {
    border: { radius: ScssReturn; stroke: ScssReturn; width: ScssReturn };
    style: {
        button: ScssReturn;
        heading: ScssReturn;
        input: ScssReturn;
        selection: ScssReturn;
    };
    transition: { properties: ScssReturn; time: ScssReturn };
    z_index: {
        nav: number;
        popup: number;
        settings: number;
        skipLink: number;
        [key: string]: number;
    };
}
Internal
Converts this token or group to the values used when converting to scss.

Returns {
    border: { radius: ScssReturn; stroke: ScssReturn; width: ScssReturn };
    style: {
        button: ScssReturn;
        heading: ScssReturn;
        input: ScssReturn;
        selection: ScssReturn;
    };
    transition: { properties: ScssReturn; time: ScssReturn };
    z_index: {
        nav: number;
        popup: number;
        settings: number;
        skipLink: number;
        [key: string]: number;
    };
}
Since
0.1.0-alpha
Overrides AbstractTokens.toScssVars
- Defined in 02-tokens/Tokens_CSS.ts:66

valueOf

valueOf(): Tokens_CSS.Data
Internal
The working value of this object.

Returns Tokens_CSS.Data
Since
0.1.0-alpha
Inherited from AbstractTokens.valueOf
- Defined in 02-tokens/abstract/AbstractTokens.ts:154

`Protected`parseSchema

parseSchema<T_Schema extends ZodTypeAny, T_ValueToTest extends unknown>(
    schema: T_Schema,
    value: T_ValueToTest,
    context: Context,
    errorMessage?: string,
    params?: Parameters<T_Schema["safeParse"]>[1],
): TypeOf<T_Schema>
Internal
A utility for parsing Zod schemas with appropriate error handling.
Type Parameters
- T_Schema extends ZodTypeAny
- T_ValueToTest extends unknown
Parameters
- schema: T_Schema
  Schema to use when parsing the value.
- value: T_ValueToTest
  The value to check against the schema.
- context: Context
  A context object used for AbstractTokens.Tokens_Error if the parsing fails.
- errorMessage: string = 'Error parsing Zod schema'
  Optional. Message to use if the parsing fails.
- params: Parameters<T_Schema["safeParse"]>[1] = {}
  Optional. Parameters passed to the Zod schema's safeParse method.
Returns TypeOf<T_Schema>
Throws
If the schema parsing fails.

Since
0.1.0-alpha
Inherited from AbstractTokens.parseSchema
- Defined in 02-tokens/abstract/AbstractTokens.ts:176

Class Tokens_CSSInternal

Since

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Tokens_CSS

Properties

Static Readonly InternaltokenLevels

Static Readonly InternaltokenLevels_extraOptions

Readonly InternaltokenLevels

Protected Readonly Internalborder

Protected Readonly Internalstyle

Protected Readonly Internaltransition

Protected Readonly InternalzIndex

Accessors

Staticdefault

Returns Omit<Tokens_CSS.Data, "border" | "style" | "transition">

data

Returns Tokens_CSS.Data

Since

Methods

StaticcustomErrorMap

Parameters

Returns { message: string }

Since

toJSON

Returns Tokens_CSS.Data

Since

toScss

Returns string

Since

toScssVars

Since

valueOf

Returns Tokens_CSS.Data

Since

ProtectedparseSchema

Type Parameters

Parameters

Returns TypeOf<T_Schema>

Throws

Since

Settings

On This Page

Class Tokens_CSS`Internal`

`Static` `Readonly` `Internal`tokenLevels

`Static` `Readonly` `Internal`tokenLevels_extraOptions

`Readonly` `Internal`tokenLevels

`Protected` `Readonly` `Internal`border

`Protected` `Readonly` `Internal`style

`Protected` `Readonly` `Internal`transition

`Protected` `Readonly` `Internal`zIndex

`Static`default

`Static`customErrorMap

`Protected`parseSchema