https://github.com/pspdfkit/pspdfkit-android-customfonts-example
Example app showing how to embed custom fonts into an app for rendering PDFs with PSPDFKit for Android
https://github.com/pspdfkit/pspdfkit-android-customfonts-example
Last synced: 10 months ago
JSON representation
Example app showing how to embed custom fonts into an app for rendering PDFs with PSPDFKit for Android
- Host: GitHub
- URL: https://github.com/pspdfkit/pspdfkit-android-customfonts-example
- Owner: PSPDFKit
- License: other
- Created: 2020-05-12T07:18:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-21T15:33:40.000Z (10 months ago)
- Last Synced: 2025-05-29T17:18:20.133Z (10 months ago)
- Language: Kotlin
- Size: 305 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nutrient for Android - Custom Fonts Example
This is the custom fonts example of [Nutrient for Android](https://nutrient.io/pdf-sdk/android/). This example shows how to ship custom font files with an app so that they can be used in situations where PDF documents require custom fonts that are not part of the Android operating system. This example is written in Kotlin, but all functions also apply to Nutrient when using Java or any other compatible programming language.
## Prerequisites
- The latest stable Android Studio version available [here](https://developer.android.com/studio).
## Getting Started
Clone and check out the custom fonts example repository on your local machine:
```sh
git clone https://github.com/PSPDFKit/pspdfkit-android-custom-fonts-example.git
cd pspdfkit-android-custom-fonts-example
```
You can now open the project inside Android Studio, or build and install the app directly from the command line:
```sh
./gradlew :installDebug
```
## Example Description
### Structure
**assets/**: The assets folder of the app (`app/src/main/assets/`) contain a custom PDF file called `Example-Fonts.pdf`. This PDF references fonts that are not part of the default system fonts of the Android operating system.
Furthermore, the assets folder contains two custom TrueType font files, which will be added to Nutrient's font include path, so that Nutrient will be able to properly render the example document.
**`CustomFontsActivity`**: This app comes with a single activity class which, upon launched, prepares the custom fonts for usage, and then launches a default `PdfActivity` for displaying the document with custom fonts.
### Disabling automatic initialization
This example project does not specify the `nutrient_license_key` as `meta-data` element inside the `AndroidManifest.xml`. This is intentional, and prevents Nutrient from automatically initializing without custom fonts. Instead, custom font loading requires the app to manually initialize Nutrient using `PSPDFKit.initialize(context, InitializationOptions(licenseKey, fontPaths))`.
## License
This software is licensed under a [modified BSD license](LICENSE).
## Additional Resources
* Nutrient for Android online guides: https://nutrient.io/guides/android/current/
* Nutrient API reference:
* KDoc: https://nutrient.io/api/android/kdoc/
* Javadoc: https://nutrient.io/api/android/javadoc/
* Nutrient technical customer support: https://nutrient.io/support/request/