Section:

Integrate WebViewer JavaScript PDF Viewer & Editor into a Vue.js App

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

You can watch a step-by-step video to help you get started.

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 webviewer-samples repository:

sh

1git clone --depth=1 https://github.com/ApryseSDK/webviewer-samples.git
2cd webviewer-samples

Next, navigate into the Vue sample folder and run npm install:

sh

1cd webviewer-vue
2npm install

This will automatically download and extract the Apryse WebViewer Package.

2. Run the Sample

Run the application by executing:

sh

1npm run serve

Then open a browser and go to localhost:8080 to see the application.

3. Usage

To call more WebViewer APIs, open /www/js/index.js in your favorite text editor and add the API calls to the callback for the WebViewer instantiation. Add your own license key in place of 'YOUR_LICENSE_KEY':

1export default {
2  name: 'WebViewer',
3  props: {
4    path: String,
5    url: String
6  },
7  mounted: function () {
8    WebViewer({
9      path: this.path,
10      licenseKey: 'YOUR_LICENSE_KEY', // sign up to get a key at https://dev.apryse.com
11      initialDoc: this.url, // replace with your own PDF file
12    }, this.$refs.viewer).then((instance) => {
13      // at this point, the viewer is 'ready'
14      const { Core, UI } = instance;
15      const { documentViewer, annotationManager, Annotations, Tools } = Core;
16
17      // See https://docs.apryse.com/web/guides/ for more info.
18      documentViewer.addEventListener('documentLoaded', function() {
19          // call methods relating to the loaded document
20      });
21    });
22  }
23}

For example, if you want to change the theme of the WebViewer to dark mode, you would add the following:

1instance.UI.setTheme('dark');

Execute npm run serve again and the theme of the viewer will change.

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