Section:

How to integrate WebViewer into a JQuery PDF Viewer

This guide will show you how to integrate WebViewer Document Viewer & Editor into a jQuery application.

You can also download a ready-to-go sample on GitHub.

Prerequisites

Prior to starting, you should have already installed Node and npm.

Get your Apryse trial key.

License Key

Apryse collects some data regarding your usage of the SDK for product improvement.

If you wish to continue without data collection, contact us and we will email you a no-tracking trial key for you to get started.

Get Started with the Sample

1. Clone the Sample

Clone the jQuery sample by executing

sh

1git clone https://github.com/ApryseSDK/webviewer-jquery-sample.git

Once cloned, navigate into the webviewer-jquery-sample directory and install all the required dependencies by executing

sh

1npm install

npm will also download the Apryse WebViewer and extract it to /src/lib.

2. Run the sample

To run the sample, navigate to your webviewer-jquery-sample/ directory and execute

sh

1npm start

Then navigate to http://localhost:3000. You should see the application load on your browser.

3. Usage

To call more WebViewer API's, navigate to /src/app/app.js and add the API calls in the callback of the WebViewer constructor (you may need to make one if it is not provided). Add your own license key in place of 'YOUR_LICENSE_KEY'.

1WebViewer({
2    path: '../lib',
3    licenseKey: 'YOUR_LICENSE_KEY', // sign up to get a key at https://dev.apryse.com
4    initialDoc: '../files/webviewer-demo-annotated.pdf'
5}, document.getElementById('viewer'))
6    .then(instance => {
7        // In this callback WebViewer will be initialized, so you can call WebViewer API here.
8        instance.UI.setTheme('light');
9    });

If your jQuery application is already running, you should see the theme change by refreshing the page. Otherwise execute npm start again, then navigate to http://localhost:3000 and you should see that the theme has changed.

Next step

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales