Swiftpack.co - Package - Nirma/SFSymbol

SFSymbol: SFSymbol and SFSymbol 2

Build Status Swift 5.3 Swift Package Manager compatible CocoaPods compatible Carthage compatible License

All the SFSymbols at your fingertips (SFSymbol 1.1 & 2)

Usage

SFSymbol and SFSymbol2 are an enums that contain the identifier strings of all of apple's SFSymbol and SFSymbol2.

For example SFSymbol.playCircle produces the String "play.circle" that can then be used to instantiate a system symbol via:

UIKit

    UIImage(symbol: .playCircle)

or

SwiftUI

    Image(symbol: .playCircle)

About

SFSymbols (1.1 and 2) 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 completion?

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.

Github

link
Stars: 122

Dependencies

Used By

Total: 0

Releases

SFSymbol 2 - 2020-08-23 17:20:16

Summary

This release includes support for SFSymbol 2 glyphs.

Please use the SFSymbol2 enum for SFSymbol 2 identifiers and SFSymbol for SFSymbol 1.1 identifiers.

https://developer.apple.com/sf-symbols/

SPM Fix for tvOS - 2020-07-30 17:17:46

Summary

This release addresses an issue with Swift Package Manager settings with iOS and tvOS versions.

SwiftUI Image extension - 2020-07-17 17:08:05

Summary

This release just simply adds the same functionality that this library added to UIKit's UIImageView.

Now you can create Images from SFSymbols in SwiftUI with a line of code like this:

    Image(symbol: .playCircle)

Xcode 12 support - 2020-07-15 16:55:06

This release adds support for Xcode 12.

Conveniently convenient - 2020-07-11 03:03:31

This version adds an even briefer way to use SFSymbols in your code like this:

UIImage(symbol: .airplane)

Swift Package Manager - 2019-11-04 12:28:55

This release simply adds in SPM support.

Here goes nothing - 2019-10-28 16:26:47

This is the initial release, I hope this micro repository finds you well.