https://github.com/99ff00/react-native-dynamic-fonts
React-Native module for loading fonts dynamically
https://github.com/99ff00/react-native-dynamic-fonts
Last synced: about 1 year ago
JSON representation
React-Native module for loading fonts dynamically
- Host: GitHub
- URL: https://github.com/99ff00/react-native-dynamic-fonts
- Owner: 99ff00
- License: mit
- Created: 2017-05-02T13:51:12.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-31T06:04:51.000Z (about 9 years ago)
- Last Synced: 2025-04-12T05:05:59.357Z (about 1 year ago)
- Language: Java
- Size: 14.6 KB
- Stars: 2
- Watchers: 1
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Native Dynamic Font Loader [](https://badge.fury.io/js/react-native-dynamic-fonts) [](https://www.npmjs.org/package/react-native-dynamic-fonts)  
A React Native module that allows you to load fonts dynamically at runtime via base64 encoded TTF or OTF, like so:
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [Options](#options)
- [Response object](#the-response-object)
## Install
`npm install react-native-dynamic-fonts@latest --save`
### Automatic Installation
`react-native link`
### Manual Installation
#### iOS
1. In the XCode's "Project navigator", right click on your project's Libraries folder ➜ `Add Files to <...>`
2. Go to `node_modules` ➜ `react-native-dynamic-fonts` ➜ `ios` ➜ select `RCTDynamicFonts.xcodeproj`
3. Add `libRCTDynamicFonts.a` to `Build Phases -> Link Binary With Libraries`
4. Compile and have fun
#### Android
1. Add the following lines to `android/settings.gradle`:
```gradle
include ':react-native-dynamic-fonts'
project(':react-native-dynamic-fonts').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-dynamic-fonts/android')
```
2. Add the compile line to the dependencies in `android/app/build.gradle`:
```gradle
dependencies {
compile project(':react-native-dynamic-fonts')
}
```
3. Add the import and link the package in `MainApplication.java`:
```java
import org.th317erd.react.DynamicFontsPackage; // <-- add this import
public class MainApplication extends Application implements ReactApplication {
@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage(),
new DynamicFontsPackage() // <-- add this line
);
}
}
```
### Example of how to use
To load a font dynamically, you must first have a base64 string of your font file (TTF or OTF):
```javascript
import { loadFont } from 'react-native-dynamic-fonts';
...
loadFonts('nameOfFont', base64FontString, 'ttf').then(function(name) {
console.log('Loaded font successfully. Font name is: ', name);
});
...
```
#### Note
On iOS, it isn't possible to specify the font name. For this reason BOTH Android and iOS return the ACTUAL registered font name. For Android this is whatever you pass in, for iOS it is whatever is embedded in the font. I suggest you always use the full name embedded in the font to avoid issues.
### Options
option | iOS | Android | Info
------ | ---- | ------- | ----
name | Not used | Used | Specify registered font name (doesn't work for iOS)
data | Used | Used | This can be a data URI or raw base64... if it is raw base64 type must be specified, but defaults to TTF (data URI mime: font/ttf or font/otf)
type | Used | Used | (optional) Specify the type of font in the encoded data (ttf or otf). Defaults to "ttf"
### The Response
The ACTUAL name the font was registered with. Use this for your fontFamily.