This guide will help you integrate a free trial of WebViewer into a jQuery applications from scratch. It will help you clone the jQuery sample repository, walk through the project structure, and show you how to call other WebViewer API. Your free trial includes unlimited trial usage and support from solution engineers.

Get the jQuery sample source code here

Prerequisites

• Node.js and npm

Initial setup

1. Clone the jQuery sample by executing

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

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

   npm install

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

You are now ready to run the sample or use more WebViewer APIs.

Sample overview

After initial setup, the webviewer-jquery-sample directory should be laid out like this:

webviewer-jqeury-sample
├── CONTRIBUTING.md
├── LICENSE
├── node_modules
│   └── ...
├── package.json
├── README.md
├── app
│    ├── index.html
|    ├── app.js
│    ├── lib
│    │   ├── ui
│    │   │   ├── ...
│    │   ├── core
│    │   │   ├── ...
│    │   └── webviewer.min.js
│    └── ...
└── ...

Notable files and directories include:

In short, app.js instantiates WebViewer and sets up some example event handlers. WebViewer is presented on the page.

Run the sample

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

npm start

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

Use more WebViewer APIs

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).

WebViewer({
    path: '../lib',
    initialDoc: '../files/webviewer-demo-annotated.pdf'
}, document.getElementById('viewer'))
    .then(instance => {
        // In this callback WebViewer will be initialized, so you can call WebViewer API here.
        instance.UI.setTheme('light');
    });

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

Guides Samples API docs