Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adapt-it/cordova-fonts
Cordova plugin for enumerating fonts on a mobile device
https://github.com/adapt-it/cordova-fonts
cordova cordova-plugin font
Last synced: about 4 hours ago
JSON representation
Cordova plugin for enumerating fonts on a mobile device
- Host: GitHub
- URL: https://github.com/adapt-it/cordova-fonts
- Owner: adapt-it
- License: apache-2.0
- Created: 2014-11-13T22:00:30.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-05-21T22:00:32.000Z (over 6 years ago)
- Last Synced: 2024-04-23T15:01:50.070Z (7 months ago)
- Topics: cordova, cordova-plugin, font
- Language: Java
- Homepage:
- Size: 53.7 KB
- Stars: 13
- Watchers: 10
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cordova-plugin-fonts
| Download Activity | Travis CI | Snyk |
|:-:|:-:|:-:|
| [](https://www.npmjs.com/package/cordova-plugin-fonts) | [](https://travis-ci.org/adapt-it/cordova-fonts) | [](https://snyk.io/test/github/adapt-it/cordova-fonts) |
A Cordova plugin that enumerates the fonts installed on the local device, and also provides the name of the default font.
This plugin defines a global `Fonts` object, which provides access to the fonts installed on the device. The `Fonts` object is available from the `navigator` object after the `deviceready` event fires.
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(navigator.Fonts);
}
## Installation
From the Command line:
cordova plugin add cordova-plugin-fonts
Config.xml for PhoneGap Build:
These commands will install the plugin from npm. You can find this plugin up on npm [here](https://www.npmjs.com/package/cordova-plugin-fonts), or by searching for `ecosystem:cordova` in the npm registry like [this](https://www.npmjs.com/search?q=ecosystem%3Acordova).
## Supported Platforms
- Android
- Amazon Fire OS (untested / just using Android code)
- Firefox OS
- iOS
# Fonts
The `Fonts` object provides a way to enumerate through the list of fonts installed on the device.
## Methods
Currently this plugin provides two methods, **getFontList** and **getDefaultFont**.
### getFontList
**Parameters:**
- **successCallback**: Callback that returns the list of fonts as an array of string values.
- **errorCallback:** Callback that executes if an error occurs while retrieving the list of fonts on the local device.
**Firefox OS quirks**
Firefox OS does not provide an API to access the fonts on the device. The Fonts plugin currently returns a list corresponding to the fonts.mk file found in the mozilla-b2g project (https://github.com/mozilla-b2g/moztt/blob/master/fonts.mk), but it is a hard-coded list and not guaranteed to be correct on any particular version or distro of Firefox OS.
### Example
if (navigator.Fonts) {
console.log("Fonts object in navigator");
navigator.Fonts.getFontList(
function (fontList) {
if (fontlist) {
for (var i = 0; i < fontlist.length; i++) {
console.log("Font: " + fontlist[i]);
}
}
},
function (error) {
console.log("FontList error: " + error);
}
);
} else {
console.log("Plugin error: Fonts plugin not found (is it installed?)");
}
### getDefaultFont
**Parameters:**
- **successCallback**: Callback that returns the string name of the default font on the device.
- **errorCallback:** Callback that executes if an error occurs during the call.
**Firefox OS quirks**
Firefox OS does not provide an API to access the fonts on the device. The Fonts plugin currently returns a hard-coded string for the default font "Fira Sans Regular". See https://www.mozilla.org/en-US/styleguide/products/firefox-os/typeface/ for more information.
### Example
if (navigator.Fonts) {
console.log("Fonts object in navigator");
navigator.Fonts.getDefaultFont(
function (defaultFont) {
if (defaultFont) {
console.log("Default Font: " + defaultFont);
}
},
function (error) {
console.log("DefaultFont error: " + error);
}
);
} else {
console.log("Plugin error: Fonts plugin not found (is it installed?)");
}
## Internal Development / Unit Testing
(This is only for devs who are developing / debugging the plugin itself)
The cordova-fonts plugin uses the cordova-plugin-test-framework to run unit tests. Complete the following to run through the plugin unit tests:
1. Use your existing cordova app, or create a new one. You can also use the test project that has already been set up for this over at https://github.com/eb1/test-fonts (just use the instructions listed there instead of the ones below).
2. Add the cordova-fonts plugin and test / test framework plugins:
cordova plugin add https://github.com/adapt-it/cordova-fonts.git
cordova plugin add https://github.com/adapt-it/cordova-fonts.git#:/tests
cordova plugin add https://github.com/apache/cordova-plugin-test-framework.git
3. Change the start page in your cordova app's `config.xml` with `` or navigate to `cdvtests/index.html` from within your app.
4. Build and run the application in an emulator or on the device.