sparrowcode/safesfsymbols

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

SafeSFSymbols

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

// Replace this
UIImage(systemName: "star.fill") 
// to this
UIImage(.star.fill)

iOS Dev Community

Navigate

• 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 Project -> Your Project Name -> Package Dependencies -> Tap Plus. Insert url:

https://github.com/sparrowcode/SafeSFSymbols

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

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

CocoaPods:

This is an outdated way. I advise you to use SPM. However, I will continue to support Cocoapods for some time.

Cocoapods Instalation

CocoaPods is a dependency manager. For usage and installation instructions, visit their website. To integrate using 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 to your Xcode project. Make sure to enable Copy items if needed and Create groups.

Usage

UIKit

let image = UIImage(.trash.circle)

SwiftUI

Image(.trash.circle)

AppKit

let image = NSImage(.trash.circle)

safesfsymbols's Issues

Default symbols are not enclosed via available attribute

Details

• iOS Version: 13-14
• Framework Version: 1.0.5
• Installed via: Cocoapods

Describe the Bug

Default symbols (without any extensions) are not enclosed via available attribute. Thus there are a lot of cases where custom UIImage's initializer public convenience init(_ symbol: SPSafeSymbol) will crash app by force-unwrapping the system image that doesn't exists at current iOS.

For example: I want to display on iOS 13 a symbol named pills, that is available starting from iOS 14.

I can do this without any error:
let image = UIImage(.pills)

And if we look into the Pills (file SPSafeSymbol+Pills) extension we will see that pills doesn't enclose via available attribute.

extension SPSafeSymbol {

	public static var pills: Pills { .init(name: "pills") }

	open class Pills: SPSafeSymbol {

		@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
		open var circle: SPSafeSymbol { ext(.start.circle) }
		@available(iOS 15.0, macOS 12.0, tvOS 15.0, watchOS 8.0, *)
		open var circleFill: SPSafeSymbol { ext(.start.circle.fill) }

		@available(iOS 14.0, macOS 11.0, tvOS 14.0, watchOS 7.0, *)
		open var fill: SPSafeSymbol { ext(.start.fill) }
	}
}