# FontBlaster

### Programmatically load custom fonts into your iOS, macOS, and tvOS app.

![Swift Support](https://img.shields.io/badge/Swift-5.9%2B-orange.svg) ![Platform](https://img.shields.io/badge/Platforms-iOS%20%7c%20macOS%20%7c%20tvOS%20-lightgray.svg?style=flat) [![SwiftPM Compatible](https://img.shields.io/badge/SwiftPM-Compatible-brightgreen.svg)](https://swift.org/package-manager/)

---

## About

Say goodbye to importing custom fonts via property lists as **FontBlaster** automatically imports and loads all fonts in your app's Bundles with one line of code.

## Features
- [x] Swift Package Manager Support
- [x] Automatically imports fonts from `Bundle.main`
- [x] Able to import fonts from remote bundles
- [x] Scans subdirectories and nested bundles recursively
- [x] Supports `.ttf`, `.otf`, and `.ttc` font files
- [x] Sample Project

## Requirements

- iOS 17.0+ / tvOS 17.0+ / macOS 14.0+
- Swift 5.9+

## Installation Instructions

### Swift Package Manager

```swift
.package(url: "https://github.com/ArtSabintsev/FontBlaster.git", from: "6.0.0")
```

### Manual

1. [Download FontBlaster](//github.com/ArtSabintsev/FontBlaster/archive/master.zip).
2. Copy `FontBlaster.swift` into your project.

## Setup

Typically, all fonts are automatically found in `Bundle.main`. Even if you have a custom bundle, it's usually lodged inside of the `mainBundle.` Therefore, to load all the fonts in your application, irrespective of the bundle it's in, simply call:

```Swift
FontBlaster.blast() // Defaults to Bundle.main if no arguments are passed
```

If you are loading from a bundle that isn't found inside your app's `mainBundle`, simply pass a reference to your `Bundle` in the `blast(bundle:)` method:

```Swift
FontBlaster.blast(bundle: myCustomBundle)
```

If you need a list of all of the loaded fonts, an overloaded version of the `blast(bundle:)` method has a completion handler that returns just that. Just like the original method, this method takes either a custom `Bundle` or defaults to `Bundle.main` if no argument is passed.

```Swift

// Defaults to Bundle.main as no argument is passed
FontBlaster.blast() { fonts in
  print(fonts) // fonts is an array of Strings containing font names
}

// Custom bundle is passed as argument
FontBlaster.blast(bundle: myCustomBundle) { fonts in
  print(fonts) // fonts is an array of Strings containing font names
}
```

Registered fonts are file-backed, so don't move or delete a font file after it has been loaded.

To turn on console debug statements, simply set `debugEnabled` to `true` **before** calling either `blast()` method:

```Swift
FontBlaster.debugEnabled = true
FontBlaster.blast()
```

## Sample Project
A Sample iOS project is included in the repo. When you launch the app, all fonts are configured to load custom fonts, but don't actually display them *until* you push the button on the navigation bar. After pushing the button, **FontBlaster** imports your fonts and redraws the view.

## Inspiration
This project builds upon an old solution that [Marco Arment](http://twitter.com/marcoarment) proposed and wrote about on his [blog](http://www.marco.org/2012/12/21/ios-dynamic-font-loading).

## Created and maintained by
[Arthur Ariel Sabintsev](http://www.sabintsev.com/)