HSFont

Type

This is a JavaScript object used to represent macOS fonts. It includes a variety of static methods that can instantiate the various font sizes commonly used with UI elements, and also includes static methods for instantiating the system font at various sizes/weights, or any custom font available on the system.

Properties

This type has no properties.

Methods

static HSFont.body()

Body text style

Hammerspoon 2/Engine/Types/HSFont.swift:16

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.callout()

Callout text style

Hammerspoon 2/Engine/Types/HSFont.swift:20

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.caption()

Caption text style

Hammerspoon 2/Engine/Types/HSFont.swift:24

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.caption2()

Caption2 text style

Hammerspoon 2/Engine/Types/HSFont.swift:28

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.footnote()

Footnote text style

Hammerspoon 2/Engine/Types/HSFont.swift:32

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.headline()

Headline text style

Hammerspoon 2/Engine/Types/HSFont.swift:36

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.largeTitle()

Large Title text style

Hammerspoon 2/Engine/Types/HSFont.swift:40

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.subheadline()

Sub-headline text style

Hammerspoon 2/Engine/Types/HSFont.swift:44

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.title()

Title text style

Hammerspoon 2/Engine/Types/HSFont.swift:48

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.title2()

Title2 text style

Hammerspoon 2/Engine/Types/HSFont.swift:52

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.title3()

Title3 text style

Hammerspoon 2/Engine/Types/HSFont.swift:56

Parameters

None

Returns

HSFont - An HSFont object

static HSFont.system(size)

The system font in a custom size

Hammerspoon 2/Engine/Types/HSFont.swift:61

Parameters

  • size number

    The font size in points

Returns

HSFont - An HSFont object

static HSFont.system(size, weight)

The system font in a custom size with a choice of weights

Hammerspoon 2/Engine/Types/HSFont.swift:68

Parameters

  • size number

    The font size in points

  • weight string

    The font weight as a string (e.g. "ultralight", "thin", "light", "regular", "medium", "semibold", "bold", "heavy", "black")

Returns

HSFont - An HSFont object

static HSFont.custom(name, size)

A font present on the system at a given size

Hammerspoon 2/Engine/Types/HSFont.swift:75

Parameters

  • name string

    A string containing the name of the font to instantiate

  • size number

    The font size in points

Returns

HSFont - An HSFont object