lukepistrol / sfsymbolsmacro

A Swift Macro for "type-safe" SF Symbols.

SFSymbolsMacro

This Swift Macro provides an easy way to make the use of SF Symbols in Swift more or less "type-safe".

Installation

Xcode

1. Click File > Add Package Dependencies
2. Paste the following link into the search field on the upper-right:

   https://github.com/lukepistrol/SFSymbolsMacro.git
   

Swift Package Manager

In Package.swift:

dependencies: [
    .package(url: "https://github.com/lukepistrol/SFSymbolsMacro.git", from: "0.1.0")
]

And then add the dependency to your targets.

Usage

Simply create an enum which will hold all the SF Symbols for your project:

enum Symbols: String {
    case circle
    case circleFill = "circle.fill"
    case shareIcon = "square.and.arrow.up"
    case globe
}

Then simply import SFSymbolsMacro and add the @SFSymbol macro annotation to the enum:

import SFSymbolsMacro
import SwiftUI

@SFSymbol
enum Symbols: String { ... }

The macro will then validate each case and the expanded macro will look something like this:

enum Symbols: String {
    case circle
    case circleFill = "circle.fill"
    case shareIcon = "square.and.arrow.up"
    case globe

    var image: Image {
        Image(systemName: self.rawValue)
    }
    var name: String {
        self.rawValue
    }
    #if canImport(UIKit)
    func uiImage(configuration: UIImage.Configuration? = nil) -> UIImage {
        UIImage(systemName: self.rawValue, withConfiguration: configuration)!
    }
    #else
    func nsImage(accessibilityDescription: String? = nil) -> NSImage {
        return NSImage(systemSymbolName: self.rawValue, accessibilityDescription: accessibilityDescription)!
    }
    #endif
    func callAsFunction() -> String {
        return self.rawValue
    }
}

In your code you can then call a symbol:

var body: some View {
    VStack {
        Symbols.circleFill.image
        Label("Globe", systemImage: Symbols.globe.name)
        // the above can also be written as
        Label("Globe", systemImage: Symbols.globe())
    }
}

In case the provided raw value is not a valid SF Symbol, Xcode will show a compile error at the enum-case in question:

Contribution

If you have any ideas on how to take this further I'm happy to discuss things in an issue.

---

sfsymbolsmacro's Issues

'image' not found when using this macro within #Preview macro

Not sure if this is a limitation of swift macros, or a bug in this library, but I thought I'd leave this here.

Seems the SFSymbol macro does not work within swiftui #Previews

Sample code:

import SFSymbolsMacro
import SwiftUI

@SFSymbol
enum Symbol: String {
    case archive = "archivebox"
    case arrowUpRightSquare = "arrow.up.right.square"
    case chevronForward = "chevron.forward"
    case checkmark = "checkmark"
    case checkmarkCircleFill = "checkmark.circle.fill"
    case checkmarkShieldFill = "checkmark.shield.fill"
    case clockArrowCirclepath = "clock.arrow.circlepath"
    case dismissKeyboard = "keyboard.chevron.compact.down"
    case ellipsis
    case exclamationmarkCircleFill = "exclamationmark.circle.fill"
    case message = "message"
    case personCircleFill = "person.circle.fill"
    case phone = "phone"
    case questionMarkCircleFill = "questionmark.circle.fill"
    case trash
    case xmarkCircleFill = "xmark.circle.fill"
}

Does not work:

#Preview {
    Label {
        Text("Some Text")
    } icon: {
        Symbol.checkmarkShieldFill.image // Value of type 'Symbol' has no member 'image'
    }
}

Works:

let icon =  Symbol.checkmarkShieldFill.image
#Preview {
    Label {
        Text("Some Text")
    } icon: {
        icon
    }
}

Some SF Symbols cases will raise errors.

Description: I imported this repository as an SPM to my project, and here's my code:

import SFSymbolsMacro

@SFSymbol
enum Symbols: String {
    case figureChildAndLockFill = "figure.child.and.lock.fill"     // This symbol encounters an error: "figure.child.and.lock.fill" is not a valid SF Symbol.
    ... // other valid cases
}

And I can confirm that the 'invalid symbol' is in SF Symbols beta 5 for sure. The snapshot below shows it:

So, why can some symbol names satisfy the compiler while others cannot?

Environment:
Xcode Version 15.0 (15A240d)
SF Symbols Beta 5