SFSymbol¶

Representation of a SF symbol.

SF symbols are Apple's configurable icons that are designed to look great with the San Francisco font.

Symbols are referenced by their name. You can find the symbol names in Apple's SF Symbols app for macOS. You can also browse symbol names in the SF Symbols Browser and San Fransymbols apps for iOS.

image¶

Convert the symbol to an image.

Read-only.

image: Image

Constructs a SF symbol.

static named(symbolName: string): SFSymbol

SF symbols are Apple's configurable icons that are designed to look great with the San Francisco font.

Symbols are referenced by their name. You can find the symbol names in Apple's SF Symbols app for macOS. You can also browse symbol names in the SF Symbols Browser and San Fransymbols apps for iOS.

symbolName
string
Name of the symbol.

SFSymbol
Constructed SF symbol or null if no symbol with the name exists.

Configures the symbol with the specified font information.

applyFont(font: Font)

Configures the symbol to use an ultra light weight.

applyUltraLightWeight()

Configures the symbol to use an thin weight.

applyThinWeight()

Configures the symbol to use an light weight.

applyLightWeight()

Configures the symbol to use an regular weight.

applyRegularWeight()

Configures the symbol to use an medium weight.

applyMediumWeight()

Configures the symbol to use an semibold weight.

applySemiboldWeight()

Configures the symbol to use an bold weight.

applyBoldWeight()

Configures the symbol to use an heavy weight.

applyHeavyWeight()

Configures the symbol to use an black weight.

applyBlackWeight()