SafeSFSymbols icon indicating copy to clipboard operation
SafeSFSymbols copied to clipboard

Safe access SFSymbols. If symbol not available, will show warning.

SafeSFSymbols

Easy usage SF Symbols with static types. If symbol not available, compiler will show warning.

  • Installation
    • Swift Package Manager
    • CocoaPods
    • Manually
  • Usage
    • UIKit
    • SwiftUI
    • AppKit

Installation

Ready to use on iOS 13+, tvOS 13+ & watchOS 6+

Swift Package Manager

In Xcode go to File -> Packages -> Update to Latest Package Versions and insert url:

https://github.com/sparrowcode/SafeSFSymbols

or adding it to the dependencies value of your Package.swift:

dependencies: [
    .package(url: "https://github.com/sparrowcode/SafeSFSymbols", .upToNextMajor(from: "1.0.6"))
]

CocoaPods:

Specify it in your Podfile:

pod 'SafeSFSymbols'

Manually

If you prefer not to use any of dependency managers, you can integrate manually. Put Sources/SafeSFSymbols folder in your Xcode project. Make sure to enable Copy items if needed and Create groups.

Usage

UIKit

To create an image:

let image = UIImage(.trash.circle)

If need with specific font, use this:

let image = UIImage(.plus, font: UIFont.preferredFont(forTextStyle: .body))

SwiftUI

To create an image:

Image(.trash.circle)

With a font:

Image(.plus)
    .font(.body)

AppKit

To create an image:

let image = NSImage(.trash.circle)

If need with specific font, use this:

let image = NSImage(.plus, font: UIFont.preferredFont(forTextStyle: .body))

Apps Using

If you use a SafeSFSymbols, add your application via Pull Request.