PSPDFKit-Cordova

The official plugin to use PSPDFKit with Apache Cordova/PhoneGap/Ionic.

Note: PSPDFKit Cordova and Ionic are being sunset and will not receive future updates after 1 December 2025. They remain available as source code, should you want to maintain them yourself. All licenses will remain valid and fully supported until 1 December 2025, or until your license expires, whichever occurs later.
Interested in transitioning to another Nutrient product? Contact us and we’ll be happy to help.

Support, Issues and License Questions

PSPDFKit offers support for customers with an active SDK license via https://pspdfkit.com/support/request/

Are you evaluating our SDK? That's great, we're happy to help out! To make sure this is fast, please use a work email and have someone from your company fill out our sales form: https://pspdfkit.com/sales/

Installation and Integration Steps

Cordova

cordova plugin add https://github.com/PSPDFKit/PSPDFKit-Cordova.git

Ionic

ionic cordova plugin add https://github.com/PSPDFKit/PSPDFKit-Cordova.git

Please follow the step-by-step installation instructions below for:

• Cordova Installation Android.
• Cordova Installation iOS.
• Ionic Installation Android.
• Ionic Installation iOS.

Requirements

• Android Cordova Requirements.
• Android Ionic Requirements.
• iOS Cordova Requirements.
• iOS Ionic Requirements.

Getting Started

Please follow the getting started guides below:

• New Cordova Project on Android
• New Ionic Project on Android
• New Cordova Project on iOS
• New Ionic Project on iOS

Example Projects

• Running the PSPDFKit-Demo Cordova Example on Android
• Running the PSPDFKit-Demo Cordova Example on iOS
• Running the PSPDFKit-Demo Ionic Example on Android
• Running the PSPDFKit-Demo Ionic Example on iOS

Documentation

• Android
• iOS

API Reference

• API Reference

Additional Resources

• How to Manipulate Annotations Programmatically in Cordova
• How to Expose Native iOS APIs to Cordova
• The All New PSPDFKit-Cordova Plugin

Troubleshooting

• Android
• iOS

Migration Guides

• Migration Guide from Cordova-Android
• Migration Guide from Cordova-iOS

License

Copyright 2011-2022 PSPDFKit GmbH. All rights reserved.

THIS SOURCE CODE AND ANY ACCOMPANYING DOCUMENTATION ARE PROTECTED BY AUSTRIAN COPYRIGHT LAW AND MAY NOT BE RESOLD OR REDISTRIBUTED. USAGE IS BOUND TO THE PSPDFKIT LICENSE AGREEMENT. UNAUTHORIZED REPRODUCTION OR DISTRIBUTION IS SUBJECT TO CIVIL AND CRIMINAL PENALTIES.

You need a commercial license to use this project. Contact [email protected] for details.