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

    Interface Family<T_Slug>Internal

    0.1.0-alpha

    interface Family<T_Slug extends string = string> {
        name: string;
        slug: T_Slug;
        weights: {
            "100"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "200"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "300"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "400"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "500"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "600"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "700"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "800"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
            "900"?: {
                italic: Tokens_Typography.Font.File;
                normal: Tokens_Typography.Font.File;
            };
        };
        appendSystemFontsToFallbacks?: boolean
        | "monospace";
        contentWidthScale?: number;
        display?: "optional" | "block" | "auto" | "fallback" | "swap";
        fallbacks?: string[];
        fontOverrideOption?: boolean;
        lineGapOverride?: string;
        lineHeightScale?: number;
        printFontFace?: boolean;
        sizeAdjust?: string;
        unicodeRange?: string;
        variable?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
    }

    Type Parameters

    • T_Slug extends string = string

    Hierarchy (View Summary)

    Index

    Properties

    name slug weights appendSystemFontsToFallbacks? contentWidthScale? display? fallbacks? fontOverrideOption? lineGapOverride? lineHeightScale? printFontFace? sizeAdjust? unicodeRange? variable?

    Properties

    name: string
    slug: T_Slug
    weights: {
        "100"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "200"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "300"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "400"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "500"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "600"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "700"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "800"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
        "900"?: {
            italic: Tokens_Typography.Font.File;
            normal: Tokens_Typography.Font.File;
        };
    }
    appendSystemFontsToFallbacks?: boolean | "monospace"

    Whether to append the system fonts list to the fallbacks when outputting to scss.

    contentWidthScale?: number

    A multiplier for the content/page widths when this font is applied as an override.

    display?: "optional" | "block" | "auto" | "fallback" | "swap"
    fallbacks?: string[]
    fontOverrideOption?: boolean

    Whether this should be an override option in website settings.

    lineGapOverride?: string
    lineHeightScale?: number

    A multiplier for the line height when this font is applied as an override.

    printFontFace?: boolean

    Whether to include font-face declarations in the css.

    true
    sizeAdjust?: string
    unicodeRange?: string
    variable?: {
        italic: Tokens_Typography.Font.File;
        normal: Tokens_Typography.Font.File;
    }

    Settings

    Member Visibility

    On This Page

    Properties