Class Tokens_Themes_Set_SingleMode<T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, __T_ColourOption>`Internal`

Generates a complete token object for the design system.

Since

0.1.0-alpha

Type Parameters

T_ColourName extends string
T_ExtraColourLevels extends Optional
T_Keyword_Universal extends string
T_Keyword_Text extends string
T_Keyword_Background extends string
__T_ColourOption extends ThemeColourOption<T_ColourName, T_ExtraColourLevels> = ThemeColourOption<T_ColourName, T_ExtraColourLevels>

Hierarchy (View Summary)

AbstractTokens<
    Tokens_Themes_Set_SingleMode.Data<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        __T_ColourOption,
    >,
>
- Tokens_Themes_Set_SingleMode

Index

Constructors

`Protected`constructor

new Tokens_Themes_Set_SingleMode<
    T_ColourName extends string,
    T_ExtraColourLevels extends "350" | "450" | "550" | "650",
    T_Keyword_Universal extends string,
    T_Keyword_Text extends string,
    T_Keyword_Background extends string,
    __T_ColourOption extends

            | "transparent"
            | "unset"
            | "AccentColor"
            | "AccentColorText"
            | "ActiveText"
            | "ButtonBorder"
            | "ButtonFace"
            | "ButtonText"
            | "Canvas"
            | "CanvasText"
            | "Field"
            | "FieldText"
            | "GrayText"
            | "Highlight"
            | "HighlightText"
            | "LinkText"
            | "Mark"
            | "MarkText"
            | "SelectedItem"
            | "SelectedItemText"
            | "VisitedText"
            | (
                | "unset"
                | "AccentColor"
                | "AccentColorText"
                | "ActiveText"
                | "ButtonBorder"
                | "ButtonFace"
                | "ButtonText"
                | "Canvas"
                | "CanvasText"
                | "Field"
                | "FieldText"
                | "GrayText"
                | "Highlight"
                | "HighlightText"
                | "LinkText"
                | "Mark"
                | "MarkText"
                | "SelectedItem"
                | "SelectedItemText"
                | "VisitedText"
            )[]
            | `${string}-100`
            | `${string}-150`
            | `${string}-200`
            | `${string}-250`
            | `${string}-300`
            | `${string}-400`
            | `${string}-500`
            | `${string}-600`
            | `${string}-700`
            | `${string}-750`
            | `${string}-800`
            | `${string}-850`
            | `${string}-900`
            | `${string}-350`
            | `${string}-450`
            | `${string}-550`
            | `${string}-650` = ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
>(
    description: string | null,
    levelsInUse: (
        | "100"
        | "150"
        | "200"
        | "250"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "750"
        | "800"
        | "850"
        | "900"
        | "350"
        | "450"
        | "550"
        | "650"
    )[],
    data: Tokens_Themes_Set_SingleMode.Data<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        __T_ColourOption,
    >,
): Tokens_Themes_Set_SingleMode<
    T_ColourName,
    T_ExtraColourLevels,
    T_Keyword_Universal,
    T_Keyword_Text,
    T_Keyword_Background,
    __T_ColourOption,
>
Internal
Type Parameters
- T_ColourName extends string
- T_ExtraColourLevels extends "350" | "450" | "550" | "650"
- T_Keyword_Universal extends string
- T_Keyword_Text extends string
- T_Keyword_Background extends string
- __T_ColourOption extends
      | "transparent"
      | "unset"
      | "AccentColor"
      | "AccentColorText"
      | "ActiveText"
      | "ButtonBorder"
      | "ButtonFace"
      | "ButtonText"
      | "Canvas"
      | "CanvasText"
      | "Field"
      | "FieldText"
      | "GrayText"
      | "Highlight"
      | "HighlightText"
      | "LinkText"
      | "Mark"
      | "MarkText"
      | "SelectedItem"
      | "SelectedItemText"
      | "VisitedText"
      | (
          | "unset"
          | "AccentColor"
          | "AccentColorText"
          | "ActiveText"
          | "ButtonBorder"
          | "ButtonFace"
          | "ButtonText"
          | "Canvas"
          | "CanvasText"
          | "Field"
          | "FieldText"
          | "GrayText"
          | "Highlight"
          | "HighlightText"
          | "LinkText"
          | "Mark"
          | "MarkText"
          | "SelectedItem"
          | "SelectedItemText"
          | "VisitedText"
      )[]
      | `${string}-100`
      | `${string}-150`
      | `${string}-200`
      | `${string}-250`
      | `${string}-300`
      | `${string}-400`
      | `${string}-500`
      | `${string}-600`
      | `${string}-700`
      | `${string}-750`
      | `${string}-800`
      | `${string}-850`
      | `${string}-900`
      | `${string}-350`
      | `${string}-450`
      | `${string}-550`
      | `${string}-650` = ThemeColourOption<T_ColourName, T_ExtraColourLevels>
Parameters
- description: string | null
- levelsInUse: (
      | "100"
      | "150"
      | "200"
      | "250"
      | "300"
      | "400"
      | "500"
      | "600"
      | "700"
      | "750"
      | "800"
      | "850"
      | "900"
      | "350"
      | "450"
      | "550"
      | "650"
  )[]
- data: Tokens_Themes_Set_SingleMode.Data<
      T_ColourName,
      T_ExtraColourLevels,
      T_Keyword_Universal,
      T_Keyword_Text,
      T_Keyword_Background,
      __T_ColourOption,
  >
Returns Tokens_Themes_Set_SingleMode<
    T_ColourName,
    T_ExtraColourLevels,
    T_Keyword_Universal,
    T_Keyword_Text,
    T_Keyword_Background,
    __T_ColourOption,
>
Overrides AbstractTokens.constructor
- Defined in 02-tokens/Themes/Themes_Set_SingleMode.ts:313

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`data

data: Tokens_Themes_Set_SingleMode.Data<
    T_ColourName,
    T_ExtraColourLevels,
    T_Keyword_Universal,
    T_Keyword_Text,
    T_Keyword_Background,
    __T_ColourOption,
>

`Readonly` `Internal`description

description: string | null

`Readonly` `Internal`levelsInUse

levelsInUse: (
    | "100"
    | "150"
    | "200"
    | "250"
    | "300"
    | "400"
    | "500"
    | "600"
    | "700"
    | "750"
    | "800"
    | "850"
    | "900"
    | "350"
    | "450"
    | "550"
    | "650"
)[]

`Readonly` `Internal`tokenLevels

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

Methods

`Static`build

build<
    T_ColourName extends string,
    T_ExtraColourLevels extends "350" | "450" | "550" | "650",
    T_Keyword_Universal extends string = never,
    T_Keyword_Text extends string = never,
    T_Keyword_Background extends string = never,
>(
    preset: "forcedColors",
    brightness: string | undefined,
    clrNames: readonly T_ColourName[],
    input: Tokens_Themes_Set_SingleMode.InputParam<
        NoInfer<T_ColourName>,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        CssSystemColor,
    >,
    overrides?: Tokens_Themes_Set_SingleMode.Data_RecursivePartial<
        NoInfer<T_ColourName>,
        NoInfer<T_ExtraColourLevels>,
        NoInfer<T_Keyword_Universal>,
        NoInfer<T_Keyword_Text>,
        NoInfer<T_Keyword_Background>,
        ThemeColourOption<NoInfer<T_ColourName>, NoInfer<T_ExtraColourLevels>>,
    >,
): Promise<
    Tokens_Themes_Set_SingleMode<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        CssSystemColor,
    >,
>
Internal
Type Parameters
- T_ColourName extends string
- T_ExtraColourLevels extends "350" | "450" | "550" | "650"
- T_Keyword_Universal extends string = never
- T_Keyword_Text extends string = never
- T_Keyword_Background extends string = never
Parameters
- preset: "forcedColors"
- brightness: string | undefined
- clrNames: readonly T_ColourName[]
- input: Tokens_Themes_Set_SingleMode.InputParam<
      NoInfer<T_ColourName>,
      T_ExtraColourLevels,
      T_Keyword_Universal,
      T_Keyword_Text,
      T_Keyword_Background,
      CssSystemColor,
  >
- Optionaloverrides: Tokens_Themes_Set_SingleMode.Data_RecursivePartial<
      NoInfer<T_ColourName>,
      NoInfer<T_ExtraColourLevels>,
      NoInfer<T_Keyword_Universal>,
      NoInfer<T_Keyword_Text>,
      NoInfer<T_Keyword_Background>,
      ThemeColourOption<NoInfer<T_ColourName>, NoInfer<T_ExtraColourLevels>>,
  >
Returns Promise<
    Tokens_Themes_Set_SingleMode<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        CssSystemColor,
    >,
>
- Defined in 02-tokens/Themes/Themes_Set_SingleMode.ts:53
build<
    T_ColourName extends string,
    T_ExtraColourLevels extends "350" | "450" | "550" | "650",
    T_Keyword_Universal extends string = never,
    T_Keyword_Text extends string = never,
    T_Keyword_Background extends string = never,
>(
    preset: "low" | "average" | "high" | "max",
    brightness: string | undefined,
    clrNames: readonly T_ColourName[],
    input: Tokens_Themes_Set_SingleMode.InputParam<
        NoInfer<T_ColourName>,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
    >,
    overrides?: Tokens_Themes_Set_SingleMode.Data_RecursivePartial<
        NoInfer<T_ColourName>,
        NoInfer<T_ExtraColourLevels>,
        NoInfer<T_Keyword_Universal>,
        NoInfer<T_Keyword_Text>,
        NoInfer<T_Keyword_Background>,
        ThemeColourOption<NoInfer<T_ColourName>, NoInfer<T_ExtraColourLevels>>,
    >,
): Promise<
    Tokens_Themes_Set_SingleMode<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
    >,
>
Internal
Type Parameters
- T_ColourName extends string
- T_ExtraColourLevels extends "350" | "450" | "550" | "650"
- T_Keyword_Universal extends string = never
- T_Keyword_Text extends string = never
- T_Keyword_Background extends string = never
Parameters
- preset: "low" | "average" | "high" | "max"
- brightness: string | undefined
- clrNames: readonly T_ColourName[]
- input: Tokens_Themes_Set_SingleMode.InputParam<
      NoInfer<T_ColourName>,
      T_ExtraColourLevels,
      T_Keyword_Universal,
      T_Keyword_Text,
      T_Keyword_Background,
      ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
  >
- Optionaloverrides: Tokens_Themes_Set_SingleMode.Data_RecursivePartial<
      NoInfer<T_ColourName>,
      NoInfer<T_ExtraColourLevels>,
      NoInfer<T_Keyword_Universal>,
      NoInfer<T_Keyword_Text>,
      NoInfer<T_Keyword_Background>,
      ThemeColourOption<NoInfer<T_ColourName>, NoInfer<T_ExtraColourLevels>>,
  >
Returns Promise<
    Tokens_Themes_Set_SingleMode<
        T_ColourName,
        T_ExtraColourLevels,
        T_Keyword_Universal,
        T_Keyword_Text,
        T_Keyword_Background,
        ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
    >,
>
- Defined in 02-tokens/Themes/Themes_Set_SingleMode.ts:91

`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_Themes_Set_SingleMode.JsonReturn<
    T_ColourName,
    T_ExtraColourLevels,
    T_Keyword_Universal,
    T_Keyword_Text,
    T_Keyword_Background,
    __T_ColourOption,
>
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_Themes_Set_SingleMode.JsonReturn<
    T_ColourName,
    T_ExtraColourLevels,
    T_Keyword_Universal,
    T_Keyword_Text,
    T_Keyword_Background,
    __T_ColourOption,
>
Since
0.1.0-alpha
Overrides AbstractTokens.toJSON
- Defined in 02-tokens/Themes/Themes_Set_SingleMode.ts:328

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(): {
    background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    } & { [K in string]: __T_ColourOption };
    button: {
        disabled: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >;
        primary: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
        secondary: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >;
    } & {
        [K in string]: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >
    };
    heading: {
        "1": __T_ColourOption;
        "10": __T_ColourOption;
        "2": __T_ColourOption;
        "3": __T_ColourOption;
        "4": __T_ColourOption;
        "5": __T_ColourOption;
        "6": __T_ColourOption;
        "7": __T_ColourOption;
        "8": __T_ColourOption;
        "9": __T_ColourOption;
    };
    input: {
        $: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        disabled: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        readonly: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
    };
    link: {
        $: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        decoration: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        icon: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        outline: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
            visited: __T_ColourOption;
        };
    };
    selection: { bg: __T_ColourOption; text: __T_ColourOption };
    system: {
        accent: { bg: __T_ColourOption; text: __T_ColourOption };
        background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
            [K in string]: __T_ColourOption
        } & { [K in string]: __T_ColourOption };
        button: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
        input: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        link: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        mark: { bg: __T_ColourOption; text: __T_ColourOption };
        selected: { bg: __T_ColourOption; text: __T_ColourOption };
        selection: { bg: __T_ColourOption; text: __T_ColourOption };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            disabled: __T_ColourOption;
        };
    };
    text: { $: __T_ColourOption } & {
        primary: __T_ColourOption;
        secondary: __T_ColourOption;
    } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        grey: __T_ColourOption;
    } & { [K in string]: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    };
    ui: { $: __T_ColourOption } & {
        primary: __T_ColourOption;
        secondary: __T_ColourOption;
    } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        grey: __T_ColourOption;
    } & { [K in string]: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    };
}
Internal
Converts this token or group to the values used when converting to scss.

Returns {
    background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    } & { [K in string]: __T_ColourOption };
    button: {
        disabled: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >;
        primary: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
        secondary: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >;
    } & {
        [K in string]: Data_Button<
            T_ColourName,
            T_ExtraColourLevels,
            __T_ColourOption,
        >
    };
    heading: {
        "1": __T_ColourOption;
        "10": __T_ColourOption;
        "2": __T_ColourOption;
        "3": __T_ColourOption;
        "4": __T_ColourOption;
        "5": __T_ColourOption;
        "6": __T_ColourOption;
        "7": __T_ColourOption;
        "8": __T_ColourOption;
        "9": __T_ColourOption;
    };
    input: {
        $: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        disabled: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        readonly: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
    };
    link: {
        $: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        decoration: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        icon: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        outline: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
            visited: __T_ColourOption;
        };
    };
    selection: { bg: __T_ColourOption; text: __T_ColourOption };
    system: {
        accent: { bg: __T_ColourOption; text: __T_ColourOption };
        background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
            [K in string]: __T_ColourOption
        } & { [K in string]: __T_ColourOption };
        button: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
        input: {
            accent: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            bg: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            border: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
            text: {
                $: __T_ColourOption;
                active: __T_ColourOption;
                hover: __T_ColourOption;
            };
        };
        link: { $: __T_ColourOption; visited: __T_ColourOption } & {
            active: __T_ColourOption;
            disabled: __T_ColourOption;
            hover: __T_ColourOption;
        };
        mark: { bg: __T_ColourOption; text: __T_ColourOption };
        selected: { bg: __T_ColourOption; text: __T_ColourOption };
        selection: { bg: __T_ColourOption; text: __T_ColourOption };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            disabled: __T_ColourOption;
        };
    };
    text: { $: __T_ColourOption } & {
        primary: __T_ColourOption;
        secondary: __T_ColourOption;
    } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        grey: __T_ColourOption;
    } & { [K in string]: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    };
    ui: { $: __T_ColourOption } & {
        primary: __T_ColourOption;
        secondary: __T_ColourOption;
    } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        grey: __T_ColourOption;
    } & { [K in string]: __T_ColourOption } & {
        [K in string]: __T_ColourOption
    };
}
- background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
  [K in string]: __T_ColourOption
  } & { [K in string]: __T_ColourOption }
- button: {
      disabled: Data_Button<
          T_ColourName,
          T_ExtraColourLevels,
          __T_ColourOption,
      >;
      primary: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
      secondary: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
  } & {
      [K in string]: Data_Button<
          T_ColourName,
          T_ExtraColourLevels,
          __T_ColourOption,
      >
  }
- heading: {
      "1": __T_ColourOption;
      "10": __T_ColourOption;
      "2": __T_ColourOption;
      "3": __T_ColourOption;
      "4": __T_ColourOption;
      "5": __T_ColourOption;
      "6": __T_ColourOption;
      "7": __T_ColourOption;
      "8": __T_ColourOption;
      "9": __T_ColourOption;
  }
- input: {
      $: {
          accent: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          bg: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          border: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          text: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
      };
      disabled: {
          accent: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          bg: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          border: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          text: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
      };
      readonly: {
          accent: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          bg: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          border: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          text: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
      };
  }
  Since
  0.1.1-alpha.0 — Changed from field to input.
  - $: {
        accent: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        bg: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        border: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
    }
    - accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
      Used for accent-color and focus ring colour.
    - bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
  - disabled: {
        accent: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        bg: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        border: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
    }
    - accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
      Used for accent-color and focus ring colour.
    - bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
  - readonly: {
        accent: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        bg: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        border: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
    }
    - accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
      Used for accent-color and focus ring colour.
    - bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
- link: {
      $: { $: __T_ColourOption; visited: __T_ColourOption } & {
          active: __T_ColourOption;
          disabled: __T_ColourOption;
          hover: __T_ColourOption;
      };
      decoration: { $: __T_ColourOption; visited: __T_ColourOption } & {
          active: __T_ColourOption;
          disabled: __T_ColourOption;
          hover: __T_ColourOption;
      };
      icon: { $: __T_ColourOption; visited: __T_ColourOption } & {
          active: __T_ColourOption;
          disabled: __T_ColourOption;
          hover: __T_ColourOption;
      };
      outline: {
          $: __T_ColourOption;
          active: __T_ColourOption;
          disabled: __T_ColourOption;
          hover: __T_ColourOption;
          visited: __T_ColourOption;
      };
  }
  - $: { $: __T_ColourOption; visited: __T_ColourOption } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        hover: __T_ColourOption;
    }
  - decoration: { $: __T_ColourOption; visited: __T_ColourOption } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        hover: __T_ColourOption;
    }
    Since
    0.1.1-alpha.0 — Renamed from link-ui to link-decoration.
  - icon: { $: __T_ColourOption; visited: __T_ColourOption } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        hover: __T_ColourOption;
    }
  - outline: {
        $: __T_ColourOption;
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        hover: __T_ColourOption;
        visited: __T_ColourOption;
    }
- selection: { bg: __T_ColourOption; text: __T_ColourOption }
- system: {
      accent: { bg: __T_ColourOption; text: __T_ColourOption };
      background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
          [K in string]: __T_ColourOption
      } & { [K in string]: __T_ColourOption };
      button: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>;
      input: {
          accent: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          bg: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          border: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
          text: {
              $: __T_ColourOption;
              active: __T_ColourOption;
              hover: __T_ColourOption;
          };
      };
      link: { $: __T_ColourOption; visited: __T_ColourOption } & {
          active: __T_ColourOption;
          disabled: __T_ColourOption;
          hover: __T_ColourOption;
      };
      mark: { bg: __T_ColourOption; text: __T_ColourOption };
      selected: { bg: __T_ColourOption; text: __T_ColourOption };
      selection: { bg: __T_ColourOption; text: __T_ColourOption };
      text: {
          $: __T_ColourOption;
          active: __T_ColourOption;
          disabled: __T_ColourOption;
      };
  }
  - accent: { bg: __T_ColourOption; text: __T_ColourOption }
  - background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
    [K in string]: __T_ColourOption
    } & { [K in string]: __T_ColourOption }
  - button: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>
  - input: {
        accent: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        bg: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        border: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
        text: {
            $: __T_ColourOption;
            active: __T_ColourOption;
            hover: __T_ColourOption;
        };
    }
    - accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
      Used for accent-color and focus ring colour.
    - bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
    - text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }
  - link: { $: __T_ColourOption; visited: __T_ColourOption } & {
        active: __T_ColourOption;
        disabled: __T_ColourOption;
        hover: __T_ColourOption;
    }
  - mark: { bg: __T_ColourOption; text: __T_ColourOption }
  - selected: { bg: __T_ColourOption; text: __T_ColourOption }
  - selection: { bg: __T_ColourOption; text: __T_ColourOption }
  - text: { $: __T_ColourOption; active: __T_ColourOption; disabled: __T_ColourOption }
- text: { $: __T_ColourOption } & {
      primary: __T_ColourOption;
      secondary: __T_ColourOption;
  } & {
      active: __T_ColourOption;
      disabled: __T_ColourOption;
      grey: __T_ColourOption;
  } & { [K in string]: __T_ColourOption } & {
      [K in string]: __T_ColourOption
  }
- ui: { $: __T_ColourOption } & {
      primary: __T_ColourOption;
      secondary: __T_ColourOption;
  } & {
      active: __T_ColourOption;
      disabled: __T_ColourOption;
      grey: __T_ColourOption;
  } & { [K in string]: __T_ColourOption } & {
      [K in string]: __T_ColourOption
  }
Since
0.1.0-alpha
Overrides AbstractTokens.toScssVars
- Defined in 02-tokens/Themes/Themes_Set_SingleMode.ts:355

valueOf

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

Returns Tokens_Themes_Set_SingleMode.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_Themes_Set_SingleMode<T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, __T_ColourOption>Internal

Since

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns Tokens_Themes_Set_SingleMode< T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, __T_ColourOption,>

Properties

Static Readonly InternaltokenLevels

Static Readonly InternaltokenLevels_extraOptions

Readonly Internaldata

Readonly Internaldescription

Readonly InternallevelsInUse

Readonly InternaltokenLevels

Methods

Staticbuild

Type Parameters

Parameters

Returns Promise< Tokens_Themes_Set_SingleMode< T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, CssSystemColor, >,>

Type Parameters

Parameters

Returns Promise< Tokens_Themes_Set_SingleMode< T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, ThemeColourOption<T_ColourName, T_ExtraColourLevels>, >,>

StaticcustomErrorMap

Parameters

Returns { message: string }

Since

toJSON

Returns Tokens_Themes_Set_SingleMode.JsonReturn< T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, __T_ColourOption,>

Since

toScss

Returns string

Since

toScssVars

background: { $: __T_ColourOption } & { alt: __T_ColourOption } & { [K in string]: __T_ColourOption} & { [K in string]: __T_ColourOption }

heading: { "1": __T_ColourOption; "10": __T_ColourOption; "2": __T_ColourOption; "3": __T_ColourOption; "4": __T_ColourOption; "5": __T_ColourOption; "6": __T_ColourOption; "7": __T_ColourOption; "8": __T_ColourOption; "9": __T_ColourOption;}

Since

accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

$: { $: __T_ColourOption; visited: __T_ColourOption } & { active: __T_ColourOption; disabled: __T_ColourOption; hover: __T_ColourOption;}

decoration: { $: __T_ColourOption; visited: __T_ColourOption } & { active: __T_ColourOption; disabled: __T_ColourOption; hover: __T_ColourOption;}

Since

icon: { $: __T_ColourOption; visited: __T_ColourOption } & { active: __T_ColourOption; disabled: __T_ColourOption; hover: __T_ColourOption;}

outline: { $: __T_ColourOption; active: __T_ColourOption; disabled: __T_ColourOption; hover: __T_ColourOption; visited: __T_ColourOption;}

selection: { bg: __T_ColourOption; text: __T_ColourOption }

accent: { bg: __T_ColourOption; text: __T_ColourOption }

background: { $: __T_ColourOption } & { alt: __T_ColourOption } & { [K in string]: __T_ColourOption} & { [K in string]: __T_ColourOption }

button: Data_Button<T_ColourName, T_ExtraColourLevels, __T_ColourOption>

accent: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

bg: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

border: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

text: { $: __T_ColourOption; active: __T_ColourOption; hover: __T_ColourOption }

link: { $: __T_ColourOption; visited: __T_ColourOption } & { active: __T_ColourOption; disabled: __T_ColourOption; hover: __T_ColourOption;}

mark: { bg: __T_ColourOption; text: __T_ColourOption }

selected: { bg: __T_ColourOption; text: __T_ColourOption }

selection: { bg: __T_ColourOption; text: __T_ColourOption }

text: { $: __T_ColourOption; active: __T_ColourOption; disabled: __T_ColourOption }

text: { $: __T_ColourOption } & { primary: __T_ColourOption; secondary: __T_ColourOption;} & { active: __T_ColourOption; disabled: __T_ColourOption; grey: __T_ColourOption;} & { [K in string]: __T_ColourOption } & { [K in string]: __T_ColourOption}

ui: { $: __T_ColourOption } & { primary: __T_ColourOption; secondary: __T_ColourOption;} & { active: __T_ColourOption; disabled: __T_ColourOption; grey: __T_ColourOption;} & { [K in string]: __T_ColourOption } & { [K in string]: __T_ColourOption}

Since

valueOf

Returns Tokens_Themes_Set_SingleMode.Data

Since

ProtectedparseSchema

Type Parameters

Class Tokens_Themes_Set_SingleMode<T_ColourName, T_ExtraColourLevels, T_Keyword_Universal, T_Keyword_Text, T_Keyword_Background, __T_ColourOption>`Internal`

`Protected`constructor

Returns Tokens_Themes_Set_SingleMode<
T_ColourName,
T_ExtraColourLevels,
T_Keyword_Universal,
T_Keyword_Text,
T_Keyword_Background,
__T_ColourOption,
>

`Static` `Readonly` `Internal`tokenLevels

`Static` `Readonly` `Internal`tokenLevels_extraOptions

`Readonly` `Internal`data

`Readonly` `Internal`description

`Readonly` `Internal`levelsInUse

`Readonly` `Internal`tokenLevels

`Static`build

Returns Promise<
Tokens_Themes_Set_SingleMode<
T_ColourName,
T_ExtraColourLevels,
T_Keyword_Universal,
T_Keyword_Text,
T_Keyword_Background,
CssSystemColor,
>,
>

Returns Promise<
Tokens_Themes_Set_SingleMode<
T_ColourName,
T_ExtraColourLevels,
T_Keyword_Universal,
T_Keyword_Text,
T_Keyword_Background,
ThemeColourOption<T_ColourName, T_ExtraColourLevels>,
>,
>

`Static`customErrorMap

Returns Tokens_Themes_Set_SingleMode.JsonReturn<
T_ColourName,
T_ExtraColourLevels,
T_Keyword_Universal,
T_Keyword_Text,
T_Keyword_Background,
__T_ColourOption,
>

background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
[K in string]: __T_ColourOption
} & { [K in string]: __T_ColourOption }

heading: {
"1": __T_ColourOption;
"10": __T_ColourOption;
"2": __T_ColourOption;
"3": __T_ColourOption;
"4": __T_ColourOption;
"5": __T_ColourOption;
"6": __T_ColourOption;
"7": __T_ColourOption;
"8": __T_ColourOption;
"9": __T_ColourOption;
}

$: { $: __T_ColourOption; visited: __T_ColourOption } & {
active: __T_ColourOption;
disabled: __T_ColourOption;
hover: __T_ColourOption;
}

decoration: { $: __T_ColourOption; visited: __T_ColourOption } & {
active: __T_ColourOption;
disabled: __T_ColourOption;
hover: __T_ColourOption;
}

icon: { $: __T_ColourOption; visited: __T_ColourOption } & {
active: __T_ColourOption;
disabled: __T_ColourOption;
hover: __T_ColourOption;
}

outline: {
$: __T_ColourOption;
active: __T_ColourOption;
disabled: __T_ColourOption;
hover: __T_ColourOption;
visited: __T_ColourOption;
}

background: { $: __T_ColourOption } & { alt: __T_ColourOption } & {
[K in string]: __T_ColourOption
} & { [K in string]: __T_ColourOption }

link: { $: __T_ColourOption; visited: __T_ColourOption } & {
active: __T_ColourOption;
disabled: __T_ColourOption;
hover: __T_ColourOption;
}

text: { $: __T_ColourOption } & {
primary: __T_ColourOption;
secondary: __T_ColourOption;
} & {
active: __T_ColourOption;
disabled: __T_ColourOption;
grey: __T_ColourOption;
} & { [K in string]: __T_ColourOption } & {
[K in string]: __T_ColourOption
}

ui: { $: __T_ColourOption } & {
primary: __T_ColourOption;
secondary: __T_ColourOption;
} & {
active: __T_ColourOption;
disabled: __T_ColourOption;
grey: __T_ColourOption;
} & { [K in string]: __T_ColourOption } & {
[K in string]: __T_ColourOption
}

`Protected`parseSchema