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

+named

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.

Parameters

symbolName
string
Name of the symbol.

Return value

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


-applyFont

Configures the symbol with the specified font information.

applyFont(font: Font)

-applyUltraLightWeight

Configures the symbol to use an ultra light weight.

applyUltraLightWeight()

-applyThinWeight

Configures the symbol to use an thin weight.

applyThinWeight()

-applyLightWeight

Configures the symbol to use an light weight.

applyLightWeight()

-applyRegularWeight

Configures the symbol to use an regular weight.

applyRegularWeight()

-applyMediumWeight

Configures the symbol to use an medium weight.

applyMediumWeight()

-applySemiboldWeight

Configures the symbol to use an semibold weight.

applySemiboldWeight()

-applyBoldWeight

Configures the symbol to use an bold weight.

applyBoldWeight()

-applyHeavyWeight

Configures the symbol to use an heavy weight.

applyHeavyWeight()

-applyBlackWeight

Configures the symbol to use an black weight.

applyBlackWeight()