Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Nirma/SFSymbol
SFSymbols 5 through 1.1 at your fingertips!
https://github.com/Nirma/SFSymbol
sfsymbol sfsymbols
Last synced: about 1 month ago
JSON representation
SFSymbols 5 through 1.1 at your fingertips!
- Host: GitHub
- URL: https://github.com/Nirma/SFSymbol
- Owner: Nirma
- License: mit
- Created: 2019-10-28T14:25:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-25T14:59:05.000Z (8 months ago)
- Last Synced: 2024-03-30T19:20:26.436Z (2 months ago)
- Topics: sfsymbol, sfsymbols
- Language: Swift
- Homepage:
- Size: 216 KB
- Stars: 188
- Watchers: 5
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-swift - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swift - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swifte - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swifty - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swift4 - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swiftxx - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- fucking-awesome-swift - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swiftqq - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
- awesome-swift - SYSymbol - All the SFSymbols at your fingertips. (Libs / Fonts)
README
# SFSymbol: SFSymbols 5 through 1.1
[](https://travis-ci.org/Nirma/SFSymbol)
[](https://github.com/apple/swift-package-manager)
[](#cocoapods)
[](https://github.com/Carthage/Carthage)
[](http://doge.mit-license.org)
All the SFSymbols at your fingertips (SFSymbol 5 through 1.1)
## Usage
`SFSymbol5`, `SFSymbol4` and so on are an `enum`s that contain the identifier strings of all of apple's SFSymbols up to version 5.0.
For example `SFSymbol.playCircle` produces the `String` `"play.circle"` that can then be used to instantiate a system symbol via:
#### UIKit
```swift
UIImage(symbol: SFSymbol4.Digitalcrown.arrowClockwiseFill)
```
*or*
#### SwiftUI
```swift
Image(symbol: SFSymbol4.Digitalcrown.arrowClockwiseFill)
```
## 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 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`](https://github.com/Nirma/SFSymbol/blob/master/Sources/SFSymbol/SFSymbol.swift) into your project's appropriate folder!
### Cocoapods
Just add this line to your podfile:
```shell
pod 'SFSymbol'
```
### Carthage
```shell
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](https://github.com/Nirma/SFSymbol/blob/master/LICENSE) for details.