Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/segecey/SwiftIconFont

Icons fonts for iOS (Font Awesome 5, Iconic, Ionicon, Octicon, Themify, MapIcon, MaterialIcon, Foundation 3, Elegant Icon, Captain Icon)
https://github.com/segecey/SwiftIconFont

cocoapods font fonts icons swift uibarbuttonitem uibutton uilabel uitextfield

Last synced: 12 days ago
JSON representation

Icons fonts for iOS (Font Awesome 5, Iconic, Ionicon, Octicon, Themify, MapIcon, MaterialIcon, Foundation 3, Elegant Icon, Captain Icon)

Awesome Lists containing this project

README

        

SwiftIconFont Banner

[![Issues](https://img.shields.io/github/issues/segecey/SwiftIconFont)](#)
[![Forks](https://img.shields.io/github/forks/segecey/SwiftIconFont)](#)
[![Stars](https://img.shields.io/github/stars/segecey/SwiftIconFont)](#)
[![Build Status](https://travis-ci.org/segecey/SwiftIconFont.svg)](https://travis-ci.org/segecey/SwiftIconFont)
[![Version](https://img.shields.io/cocoapods/v/SwiftIconFont.svg?style=flat)](http://cocoapods.org/pods/SwiftIconFont)
[![License](https://img.shields.io/cocoapods/l/SwiftIconFont.svg?style=flat)](http://cocoapods.org/pods/SwiftIconFont)
[![Platform](https://img.shields.io/badge/Platforms-iOS%C2%A0%7C%20macOS%20%7C%20tvOS-green)](http://cocoapods.org/pods/SwiftIconFont)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

## Installation

### SPM

**Not yet supported. Please use Cocoapods or Carthage**

### Carthage

```bash
github "segecey/SwiftIconFont"
```

### Cocoapods

[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects.

You can install it with the following command:

```bash
gem install cocoapods
```

To integrate SwiftIconFont into your Xcode project using CocoaPods, specify it in your `Podfile`:

```ruby
use_frameworks!

pod 'SwiftIconFont'
```

## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Prefixes

| Font | Prefix | Cheat Sheet |
| -------------------- | ------ | -------------------------------------------------------------------------------------- |
| Font Awesome 5 | fa5: | [List](http://fontawesome.io/icons/) |
| Font Awesome 5 Brand | fa5b: | [List](http://fontawesome.io/icons/) |
| Font Awesome 5 Solid | fa5s: | [List](http://fontawesome.io/icons/) |
| Ion Icons | io: | [List](http://ionicons.com) |
| Octicons | oc: | [List](https://octicons.github.com) |
| Open Iconic | ic: | [List](https://useiconic.com/open/) |
| Material Icon | ma: | [List](https://design.google.com/icons/) |
| Themify | ti: | [List](https://themify.me/themify-icons) |
| Map Icons | mi: | [List](http://map-icons.com) |
| Segoe MDL2 | sm: | [List](https://docs.microsoft.com/en-us/windows/uwp/design/style/segoe-ui-symbol-font) |
| Foundation 3 | fo: | [List](https://zurb.com/playground/foundation-icon-fonts-3) |
| Elegant Icon | el: | [List](https://www.elegantthemes.com/blog/resources/elegant-icon-font) |
| Captain | cp: | Please check example project. |

## Fonts

```swift
public enum Fonts: String {
case fontAwesome5 = "FontAwesome5Free-Regular"
case fontAwesome5Brand = "FontAwesome5Brands-Regular"
case fontAwesome5Solid = "FontAwesome5Free-Solid"
case iconic = "open-iconic"
case ionicon = "Ionicons"
case octicon = "octicons"
case themify = "themify"
case mapIcon = "map-icons"
case materialIcon = "MaterialIcons-Regular"
case segoeMDL2 = "Segoe mdl2 assets"
case foundation = "fontcustom"
case elegantIcon = "ElegantIcons"
case captain = "captainicon"
}
```

## Storyboard

SwiftIconFont Banner

## Runtime Structure

> < Prefix >:< Icon >

## Usage

In your UILabel, UIButton or UITextField, set a text containing a placeholder anywhere you want the icon to be. Somethink like this

> oc:logo-github

Then you can choose between 3 ways you can use SwiftIconFont.

#### 1. Without Custom Class

Simply import SwiftIconFont and call processIcons on any UILabel, UIButton or UITextField that has a placeholder.

```swift
label.parseIcon()
```

#### 2. Custom Class

The lazy way, just set your UILabel, UITextField, UIButton, UITextView, UIBarButtonItem class as SwiftIconLabel, SwiftIconTextField, SwiftIconButton, SwiftIconTextView, SwiftBarButtonItem, and thats it, your icons will be processed at runtime.

#### 3. Programmatically

```swift
import SwiftIconFont

label.font = UIFont.icon(from: .fontAwesome5, ofSize: 50.0)
label.text = String.fontAwesome5Icon(code: "twitter")
```

#### UIBarButtonItem (Without Custom Class)

```swift
import SwiftIconFont

twitterBarButton.icon(from: .fontAwesome5, code: "twitter", ofSize: 20)
```

#### UITabBarItem (Without Custom Class)

```swift
import SwiftIconFont

twitterTabBarButton.icon(from: .fontAwesome5, code: "twitter", imageSize: CGSizeMake(20, 20), ofSize: 20)
```

#### UIImage

```swift
import SwiftIconFont

let githubLogo = UIImage(from: .octicon, code: "logo-github", textColor: .black, backgroundColor: .clear, size: CGSize(width: 150, height: 50))
```

#### UIImageView

```swift
import SwiftIconFont

let githubLogoImageView: UIImageView = UIImageView(frame: CGRect(x: 120, y: self.view.frame.size.height - 130, width: 150, height: 50))
githubLogoImageView.setIcon(from: .octicon, code: "logo-github", textColor: .black, backgroundColor: .clear, size: nil)
```

#### macOS

- NSTextField, NSImage, NSView
- Please check **ExampleMac** project

## Author

Sedat ÇİFTÇİ - [email protected]

## Contributors

josejuanqm

## License

SwiftIconFont is available under the MIT license. See the LICENSE file for more info.

## Contributing

1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request