jollyjinx/sfsymbolenum

A Swift package that exposes SF Symbols as an enum instead of verbatim strings.

Advantages

Compiler error when you mistype a SFSymbol name
Autocompletion and suggestion for all SFSymbols:

Images are available depending on os and version like this:

Installation

Add the package to your project: Xcode->Add Package Dependency add this url: https://github.com/jollyjinx/SFSymbolEnum
Import in files like this:

     import SFSymbolEnum

Usage

functions that are using the systemImage argument can be used as before, but instead with the dot notation. Symbol names translate to enums by replacing dots notation to camelcase and prefixing starting numbers with number.

Examples:

    Image(systemName:"arrow.down.left.circle.fill")
    Image(systemName:"0.circle")
    Image(systemName:"arrow.2.circlepath.circle")

becomes to:

    Image(systemName:.arrowDownLeftCircleFill)    
    Image(systemName:.number0Circle)    
    Image(systemName:.arrow2CirclepathCircle)

How it's done

The generated code is created from name_availability.plist inside the SF Symbols application and looks like this:

public enum SFSymbol: String, Sendable {
    @available(iOS 13.0, macOS 10.15, tvOS 13.0, visionOS 1.0, watchOS 6.0, *) case number0Circle = "0.circle"
    @available(iOS 13.0, macOS 10.15, tvOS 13.0, visionOS 1.0, watchOS 6.0, *) case number0CircleFill = "0.circle.fill"
...
}

extension SFSymbol: CaseIterable {
    public static let allCases: [SFSymbol] = {
        var allCases: [SFSymbol] = []
        if #available(iOS 13.0, macOS 10.15, tvOS 13.0, visionOS 1.0, watchOS 6.0, *) {
            allCases.append(contentsOf: [.number0Circle, .number0CircleFill])
        }
...
        return allCases
    }()
}

Package Metadata

Repository: jollyjinx/sfsymbolenum

Default branch: main

README: README.md