Type Alias FontProperties

An object representing a local font, or a family of fonts.

type FontProperties = {
    name: string;
    pathOrDirectory: string;
    stylesPerWeights?:
        | Record<string, string>
        | Record<number, Record<string, string>>;
    format?: string;
    extension?: string;
}

Properties

name: string

The name of the font. The font's filename should also match.

pathOrDirectory: string

The path to the local font file, or the path to the local font family's directory.

stylesPerWeights?:
| Record<string, string>
| Record<number, Record<string, string>>

format?: string

The format of the font. Defaults to "woff2".

extension?: string

The extension of the font file(s). Defaults to ".ttf".