https://github.com/iron-ham/octicons.swift
A scalable set of icons
https://github.com/iron-ham/octicons.swift
icons ios macos octicons-helper svg swift tvos watchos
Last synced: 10 months ago
JSON representation
A scalable set of icons
- Host: GitHub
- URL: https://github.com/iron-ham/octicons.swift
- Owner: Iron-Ham
- License: mit
- Created: 2021-11-06T14:22:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T19:28:29.000Z (over 2 years ago)
- Last Synced: 2024-03-12T20:40:41.363Z (over 2 years ago)
- Topics: icons, ios, macos, octicons-helper, svg, swift, tvos, watchos
- Language: Swift
- Homepage: https://primer.style/octicons/
- Size: 936 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Octicons.swift
Do you like [Octicons](https://primer.style/octicons/)? I do too.
The purpose of this package is to make them available to iOS, tvOS, watchOS, and macOS apps in UIKit, AppKit, and SwiftUI.
These Octicons are all being represented by SVGs.
## Installation
This package is available through Swift Package Manager.
## Usage
This package requires the following minimum versions in your project:
- macOS 10_15
- iOS 13
- watchOS 6
- tvOS 13
Note that these are the same requirements of SwiftUI.
### UIKit
```swift
let image: UIImage = Octicons.alert24.image
```
### SwiftUI
```swift
let image: Image = Octicons.alert24.swiftUiImage
```
## Contributing
I'm more than happy to accept Pull Requests!
New [Octicons](https://github.com/primer/octicons) are added all the time, and I'm not necessarily adding them as soon as I can.
In order to re-generate all of the Octicons in the media bundle, you'll need to have [SwiftGen](https://github.com/SwiftGen/SwiftGen#installation) installed.
Then, run the following command:
```sh
swiftgen config run --config swiftgen.yml
```