kernjackson / sfsymbol

All the SFSymbols at your fingertips

SFSymbol

All the SFSymbols at your fingertips

Usage

SFSymbol is an enum that contains the identifier strings of all SFSymbols that were available at the time of this writing. For example SFSymbol.playCircle produces the String "play.circle" that can then be used to instantiate a system symbol via:

UIKit

    UIImage(systemName: .playCircle)

or

SwiftUI

    Image(systemName: .playCircle)

About

SFSymbols is a real treat from apple, Apple's official list of Symbols that are available to use free of charge when writing software on any of Apple's recent platforms. There is one downfall however, it is a pain in the neck to look up exact symbol names, take for example:

"square.and.line.vertical.and.square.fill"

That is a long string to remember and digging through the catalog of SF Symbols to find in would be quite a waste of time.

Wouldn't it be easier if you could just use code complete?

Thats what this super micro library aims to do.

Installation

Swift Package Manager (Preferred)

Since Xcode integrated swift package manager natively into the IDE you can add SFSymbol simply by:

File-> Swift Packages -> Add Package Dependency...

when prompted to enter a package URL paste:

https://github.com/Nirma/SFSymbol

and click next & finish to automagically install SFSymbol through Xcode & SPM!

Manual

Don't want that additional third party dependency? Then just simply copy over the file SFSymbol.swift into your project's appropriate folder!

Cocoapods

Just add this line to your podfile:

pod 'SFSymbol'

Carthage

github "Nirma/SFSymbol"

Contributing to this project

Contributions are highly welcome

If there is something you wish to fix about the project, or wish to add any other kind of enhancements, propose to add to the project. Please feel free to send over a pull request or open an issue for this project.

License

SFSymbol is released under the MIT license. See LICENSE for details.