Interface Font

Represents a font in Penpot, which includes details about the font family, variants, and styling options. This interface provides properties and methods for describing and applying fonts within Penpot.

interface Font {
    name: string;
    fontId: string;
    fontFamily: string;
    fontStyle?: null | "normal" | "italic";
    fontVariantId: string;
    fontWeight: string;
    variants: FontVariant[];
    applyToText(text: Text, variant?: FontVariant): void;
    applyToRange(range: TextRange, variant?: FontVariant): void;
}

Properties

name fontId fontFamily fontStyle? fontVariantId fontWeight variants

Methods

applyToText applyToRange

Properties

name

name: string

This property holds the human-readable name of the font.

fontId

fontId: string

The unique identifier of the font.

fontFamily

fontFamily: string

The font family of the font.

OptionalfontStyle

fontStyle?: null | "normal" | "italic"

The default font style of the font.

fontVariantId

fontVariantId: string

The default font variant ID of the font.

fontWeight

fontWeight: string

The default font weight of the font.

variants

variants: FontVariant[]

An array of font variants available for the font.

Methods

applyToText

  • applyToText(text, variant?): void

  • Applies the font styles to a text shape.

    Parameters

    • text: Text

      The text shape to apply the font styles to.

    • Optionalvariant: FontVariant

      Optional. The specific font variant to apply. If not provided, applies the default variant.

    Returns void

    Example

    font.applyToText(textShape, fontVariant);

applyToRange

  • applyToRange(range, variant?): void

  • Applies the font styles to a text range within a text shape.

    Parameters

    • range: TextRange

      The text range to apply the font styles to.

    • Optionalvariant: FontVariant

      Optional. The specific font variant to apply. If not provided, applies the default variant.

    Returns void

    Example

    font.applyToRange(textRange, fontVariant);

Settings

Member Visibility

On This Page

Properties
Methods