yannickl / DynamicFont

Yet another extension to manipulate fonts easily in Swift

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

DynamicFont

Supported Platforms Version Carthage compatible Build status Code coverage status Codebeat badge

DynamicFont provides powerful methods to manipulate font in an easy way in Swift.

RequirementsUsageInstallationContactLicense

Requirements

  • iOS 10.0+
  • Xcode 8.0+
  • Swift 3.0+

Usage

To begin, let's start with the font creation thanks to a DynamicFontFamily:

import DynamicFont

// Helvetica Font
let helvetica = DynamicFont(family: .helvetica, size: 12)
// Equivalent to
// let helvetica = UIFont(family: .helvetica, size: 12)

Notice that the initializer returns a font and not an optional like the designated UIFont initializer

Now you can transform your font appearance by modifying its size or by italicizing it:

// Helvetica-Bold
let bold = helvetica.withWeight(.bold)

// Helvetica-BoldOblique
let boldItalic = bold.withItalic()

You can change the weight of the font by picking one of this case:

enum DynamicFontWeight {
  /// The ultra light font weight.
  case ultraLight
  /// The thin font weight.
  case thin
  /// The light font weight.
  case light
  /// The regular font weight.
  case regular
  /// The medium font weight.
  case medium
  /// The semibold font weight.
  case semibold
  /// The bold font weight.
  case bold
  /// The heavy font weight.
  case heavy
  /// The black font weight.
  case black
}

And many more...

To go further, take a look at the example project.

Installation

CocoaPods

Install CocoaPods if not already available:

$ [sudo] gem install cocoapods
$ pod setup

Go to the directory of your Xcode project, and Create and Edit your Podfile and add DynamicFont:

$ cd /path/to/MyProject
$ touch Podfile
$ edit Podfile
source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'

use_frameworks!
pod 'DynamicFont', '~> 1.0.1'

Install into your project:

$ pod install

Open your project in Xcode from the .xcworkspace file (not the usual project file):

$ open MyProject.xcworkspace

You can now import DynamicFont framework into your files.

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate DynamicFont into your Xcode project using Carthage, specify it in your Cartfile file:

github "yannickl/DynamicFont" >= 1.0.1

Swift Package Manager

You can use The Swift Package Manager to install DynamicFont by adding the proper description to your Package.swift file:

import PackageDescription

let package = Package(
    name: "YOUR_PROJECT_NAME",
    targets: [],
    dependencies: [
        .Package(url: "https://github.com/yannickl/DynamicFont.git", versions: "1.0.1" ..< Version.max)
    ]
)

Note that the Swift Package Manager is still in early design and development, for more information checkout its GitHub Page.

Manually

Download the project and copy the DynamicFont folder into your project to use it in.

Contact

Yannick Loriot

License (MIT)

Copyright (c) 2016-present - Yannick Loriot

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Yet another extension to manipulate fonts easily in Swift

License:MIT License


Languages

Language:Swift 97.2%Language:Ruby 2.8%