Design System Utilities @ 0.1.1-alpha.0
    Preparing search index...

    Interface InputParam<T_ColourName, T_ExtraColourLevels, T_ThemeKeyword_Universal, T_ThemeKeyword_Text, T_ThemeKeyword_Background>

    0.1.0-alpha

    interface InputParam<
        T_ColourName extends string = Default_ColourName,
        T_ExtraColourLevels extends Optional = Default_ExtraColourLevels,
        T_ThemeKeyword_Universal extends string = never,
        T_ThemeKeyword_Text extends string = never,
        T_ThemeKeyword_Background extends string = never,
    > {
        description?: string | null;
        levels?: {
            background?:
                | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels
                | Partial<LevelsSet_AccentAlt<T_ExtraColourLevels>>;
            heading?:
                | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels
                | {
                    "1"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "10"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "2"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "3"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "4"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "5"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "6"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "7"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "8"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                    "9"?: | "100"
                    | "150"
                    | "200"
                    | "250"
                    | "300"
                    | "400"
                    | "500"
                    | "600"
                    | "700"
                    | "750"
                    | "800"
                    | "850"
                    | "900"
                    | T_ExtraColourLevels;
                };
            text?: | "100"
            | "150"
            | "200"
            | "250"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "750"
            | "800"
            | "850"
            | "900"
            | T_ExtraColourLevels
            | Partial<LevelsSet_AccentMin<T_ExtraColourLevels>>;
            ui?:
                | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels
                | Partial<LevelsSet_AccentMin<T_ExtraColourLevels>>;
        };
        variations?: {
            background?: Partial<{ alt: T_ColourName }> & {
                [K in string]: T_ColourName
            };
            heading?: Partial<
                {
                    "1": T_ColourName;
                    "10": T_ColourName;
                    "2": T_ColourName;
                    "3": T_ColourName;
                    "4": T_ColourName;
                    "5": T_ColourName;
                    "6": T_ColourName;
                    "7": T_ColourName;
                    "8": T_ColourName;
                    "9": T_ColourName;
                },
            > & { [key: number]: T_ColourName };
            interactive?: Partial<
                { active: T_ColourName; disabled: T_ColourName; hover: T_ColourName },
            >;
            text?: Partial<
                { active: T_ColourName; disabled: T_ColourName; grey: T_ColourName },
            > & { [K in string]: T_ColourName };
            universal?: Partial<{ primary: T_ColourName; secondary: T_ColourName }> & {
                [K in string]: T_ColourName
            };
        };
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    description?: string | null
    levels?: {
        background?:
            | "100"
            | "150"
            | "200"
            | "250"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "750"
            | "800"
            | "850"
            | "900"
            | T_ExtraColourLevels
            | Partial<LevelsSet_AccentAlt<T_ExtraColourLevels>>;
        heading?:
            | "100"
            | "150"
            | "200"
            | "250"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "750"
            | "800"
            | "850"
            | "900"
            | T_ExtraColourLevels
            | {
                "1"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "10"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "2"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "3"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "4"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "5"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "6"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "7"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "8"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
                "9"?: | "100"
                | "150"
                | "200"
                | "250"
                | "300"
                | "400"
                | "500"
                | "600"
                | "700"
                | "750"
                | "800"
                | "850"
                | "900"
                | T_ExtraColourLevels;
            };
        text?: | "100"
        | "150"
        | "200"
        | "250"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "750"
        | "800"
        | "850"
        | "900"
        | T_ExtraColourLevels
        | Partial<LevelsSet_AccentMin<T_ExtraColourLevels>>;
        ui?:
            | "100"
            | "150"
            | "200"
            | "250"
            | "300"
            | "400"
            | "500"
            | "600"
            | "700"
            | "750"
            | "800"
            | "850"
            | "900"
            | T_ExtraColourLevels
            | Partial<LevelsSet_AccentMin<T_ExtraColourLevels>>;
    }
    variations?: {
        background?: Partial<{ alt: T_ColourName }> & {
            [K in string]: T_ColourName
        };
        heading?: Partial<
            {
                "1": T_ColourName;
                "10": T_ColourName;
                "2": T_ColourName;
                "3": T_ColourName;
                "4": T_ColourName;
                "5": T_ColourName;
                "6": T_ColourName;
                "7": T_ColourName;
                "8": T_ColourName;
                "9": T_ColourName;
            },
        > & { [key: number]: T_ColourName };
        interactive?: Partial<
            { active: T_ColourName; disabled: T_ColourName; hover: T_ColourName },
        >;
        text?: Partial<
            { active: T_ColourName; disabled: T_ColourName; grey: T_ColourName },
        > & { [K in string]: T_ColourName };
        universal?: Partial<{ primary: T_ColourName; secondary: T_ColourName }> & {
            [K in string]: T_ColourName
        };
    }