Swiftpack.co - Package - donavoncade/SFSymbolsPackage

SFSymbolsPackage

Description

I wanted an easier way to access SF Symbols in my projects. This has some added organization and a few convenience features. My goal is to make this easier to maintain as Apple updates their available SF Symbols. Also, if anyone at Apple happens to come across this, I would love to kill this project. 😜 All SFSymbols and Categories are listed here in the order in which they are presented in the macOS SF Symbols app Version 1.1 (16). All enums in this package conform to CaseIterable and Identifiable. You won't need to provide your own id: when used with ForEach in SwiftUI.

Usage

Symbol String ID

import SwiftUI
import SFSymbolsPackage

struct ExampleSwiftUIView: View {

let symbol: String

var body: some View {

    // Provided inits accept String or any type conforming to SFSymbol protocol
    Image(symbol: symbol)
        .resizable()
        .aspectRatio(contentMode: .fit)
        .padding()
    }

}

Generic usage

If you're not using mixed categorized symbols, it may be easier use generic types that conform to the SFSymbol protocol. Even though they have the same RawValue type, mixing symbol categories will not compile the way this is written currently. If you know how to fix this, let me know.

import SwiftUI
import SFSymbolsPackage

struct ExampleSwiftUIView<S:SFSymbol>: View {

let symbol: S

var body: some View {

    // Provided inits accept String or any type conforming to SFSymbol protocol
    Image(symbol: symbol)
        .resizable()
        .aspectRatio(contentMode: .fit)
        .padding()
    }
    
}

Initialization

// SwiftUI Image
let image = Image(symbol: SFSymbols._00Circle)
// or
let image = Image(symbol: SFSymbols._00Circle.id)
// SwiftUI Label - available on iOS 14+, OSX 11+, watchOS 7+, tvOS 14+
let label = Label("Title String", symbol: SFSymbols._00Circle)
// or
let label = Label("Title String", symbol: SFSymbols._00Circle.id)
// UIImage
let image = UIImage(symbol: SFSymbols._00Circle)
// or
let image = UIImage(symbol: SFSymbols._00Circle.id)

Categories

SFSymbols.Communication
SFSymbols.Weather
SFSymbols.ObjectsAndTools
SFSymbols.Devices
SFSymbols.Connectivity
SFSymbols.Transportation
SFSymbols.Human
SFSymbols.Nature
SFSymbols.Editing
SFSymbols.TextFormatting
SFSymbols.Media
SFSymbols.Keyboard
SFSymbols.Commerce
SFSymbols.Time
SFSymbols.Health
SFSymbols.Shapes
SFSymbols.Arrows
SFSymbols.Indices
SFSymbols.Math
SFSymbols.Uncategorized

Example Project

SymbolGrid-Demo

Contact

Twitter: @dbuchanandev

License

From Apple:

All SF Symbols shall be considered to be system-provided images as defined in the Xcode and Apple SDKs license agreements and are subject to the terms and conditions set forth therein. You may not use SF Symbols — or glyphs that are substantially or confusingly similar — in your app icons, logos, or any other trademark-related use. Apple reserves the right to review and, in its sole discretion, require modification or discontinuance of use of any Symbol used in violation of the foregoing restrictions, and you agree to promptly comply with any such request.

source: Human Interface Guidelines - SF Symbols

Github

link
Stars: 1

Dependencies

Used By

Total: 0