jjohansson-pdftron / webviewer-typescript-sample

WebViewer - TypeScript sample

WebViewer is a powerful JavaScript-based PDF Library that's part of the PDFTron PDF SDK. It provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.

This repo is specifically designed for any users interested in integrating WebViewer into a TypeScript project. WebViewer has a comprehensive definition file ready for use by just adding a reference to the definition file.

Initial setup

Before you begin, make sure your development environment includes Node.js.

Install

git clone https://github.com/PDFTron/webviewer-typescript-sample.git
cd webviewer-typescript-sample
npm install

Run

Setup the TypeScript compiler to watch for changes and recompile the source file:

npm run watch

Open a different shell service and run:

npm start

WebViewer APIs

Most classes and functions are well documented in the TypeScript definition file. See API documentation.

Enabling full API

PDFNetJS Full is a complete browser side PDF SDK, unlocking viewing, parsing and editing of PDF files. To enable full API, you can modify constructor in src/index.ts and then use tsc src/index.ts from the project root:

const viewerElement = document.getElementById('viewer');
WebViewer({
    path: 'WebViewer/lib',
    initialDoc: 'path/to/local/file OR online URL', // replace with your own PDF file
+   fullAPI: true
}, viewerElement).then((instance) => {
    // call APIs here
    })
}

License

See license.