Adding to Your Project

This guide will walk you through adding PSPDFKit for Electron to your Electron project.

Accessing license information — for evaluation

After requesting an evaluation license, follow the PSPDFKit for Electron trial link in the email you received. This will automatically fill in the license information in the following examples on this page.

Accessing license information — for existing customers

  1. In your web browser, log in to https://customers.pspdfkit.com and navigate to the Your Licenses & Keys page.
  2. Locate your PSPDFKit for Electron license and click Download PSPDFKit for Electron.
  3. Follow the instructions in the Install with npm section below.

Install with npm

PSPDFKit for Electron is installed as an npm package. This will add a dependency with the name pspdfkit to your application’s package.json.

Using the Latest Release:

1
yarn add pspdfkit
1
npm install --save pspdfkit

Pinning to a Specific Version (e.g. 2018.2.0):

1
yarn add pspdfkit@2018.2.0
1
npm install --save pspdfkit@2018.2.0

Now you can start using PSPDFKit for Electron from any JavaScript file that runs in your renderer process. Follow the Integration guide for your next steps.

Example Application

We’ve prepared a ready-to-use example project that will help you get started quickly.