SFSymbolsFinder
SFSymbolsFinder is a convenient library to get whole list of available latest SF Symbols image
Introduction
SFSymbolsFinder introduces 22 SF Symbols categories, each category represented by an enum
:
General
Communication
Weather
ObjectsAndTools
Devices
Connectivity
Transportation
Human
Nature
Editing
Text Formatting
Media
Keyboard
Commerce
Time
Health
Shapes
Arrows
Indices
Math
Gaming
Multicolor
All
All categories is based on official Apple SF Symbols application sfsymbols
All icons has been updated, now all icons are supported. Please refer to All Categories to get all icon. Contribution welcome !
Usage
New Update!
Now you can use smart init directly!
Image(systemName: .person)
UIImage(systemName: .person)
General Usage
Use it easily with calling the enum for each category
import SFSymbolsFinder
import SwiftUI
struct ContentView: View {
var body: some View {
VLayout {
// Approach 1 by using Image directly
VLayout {
Communication.micSlashFill.image
.resizable()
}
// Approach 2 by using the system name string
VLayout {
Image(systemName: Communication.micSlashFill.systemName)
.resizable()
}
// Approach 3 by using enum directly
VLayout {
All.micSlashFill // this one is recognized as an Image already
// If you want to resize you need to access the body
All.micSlashFill.body
.resizable()
}
}
}
}
To get the uiImage version you can use below code
All.micSlashFill.uiImage
There are some categories that need special way to retrieve the symbols:
ObjectAndTools
For one of the icon which is oneMagnifyingglass
is used for getting 1.magnifyingglass
system name
Indices
For indices there are special ways to get 3 special symbols which is for retrieving Currency
, Alphabet
, and Number
.
- For number, it supports generic type
// With Int
Indices.Number.circle(number: 1).systemName
// With String
Indices.Number.circle(number: "01").systemName
Please beware not every number or string is supported, in case we put 999 or "-123" it won't return anything.
- For
Alphabet
, it supports by passingCharacter
enum. It supportsa
toz
.
Indices.Alphabet.circle(character: .a).systemName // return a.circle
- For
Currency
, it supports by passingAvailableCurrency
enum.
Indices.Currency.circle(currency: .dollar).systemName // return dollarsign.circle
All
All icons are useful in case you don't want to use a category based. Just copy the name from SF Symbols App then use enum style code.
// In sf symbols : xmark.circle
// In code like below
All.xmarkCircle.systemName
NOTE: For number still need to use Indices.Number
Installation
SFSymbolsFinder is distributed using the Swift Package Manager. To install it into a project, follow this tutorial and use this repository URL: https://github.com/abadikaka/SFSymbolsFinder.git
.
Credits
SFSymbolsFinder was built by Michael Abadi S. as a component of some of his project described in his website.
Contributions and Support
All users are welcome and encouraged to become active participants in the project continued development β by fixing any bug that they encounter, or by improving the documentation wherever itβs found to be lacking, and adding more or missing available SF Symbols, or even only adding a Unit Test.
If you'd like to make a change, please open a Pull Request, even if it just contains a draft of the changes youβre planning, or a test that reproduces an issue.
If you'd like to open an issue, please submit new issue.
Todo
- Add generic validation for system name
- Add more iOS 14 symbols
- Add more iOS 13 symbols that not included in any Categories
Thank you and please enjoy using SFSymbolsFinder!