Section:

How to integrate WebViewer into a Svelte PDF Viewer

This guide will show you how to integrate WebViewer Document Viewer & Editor into a Svelte 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 Svelte sample by executing

sh

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

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

sh

1npm install

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

2. Run the sample

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

sh

1npm run dev

Then navigate to http://localhost:5000. You should see WebViewer start up and load the sample PDF. Note it will change in real time if you edit any of the source files.

Apryse Docs Image

3. Usage

To call more WebViewer API's, navigate to /src/WebViewer.svelte 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'.

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

If your Svelte application is already running, you should see the theme change right away. Otherwise execute npm run dev again, then navigate to http://localhost:5000 and you should see that the theme has changed.

Apryse Docs Image

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