@pdftron/pdfjs-express
v8.7.5
Published
[PDFJS Express](https://pdfjs.express) is a powerful JavaScript-based PDF Library that wraps [PDF.js](https://mozilla.github.io/pdf.js/). It provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulat
Downloads
34,737
Readme
WebViewer
PDFJS Express is a powerful JavaScript-based PDF Library that wraps PDF.js. 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.
Usage
1) Install PDFJS Express
npm i @pdftron/pdfjs-express --save
This will also download all the assets that need to be included for PDFJS Express to work.
2) Copy assets and resources to your public/static folder
These assets need to be served with your application. For example, if your project is built into a dist
folder, you could copy these assets into dist/public
.
The folder you need to copy is node_modules/@pdftron/pdfjs-express/public
.
cp -R ./node_modules/@pdftron/pdfjs-express/public ./dist
We recommend using a module bundler like Webpack to automatically do this for you. There is a nice plugin called copy-webpack-plugin that does just this.
3) Import and instantiate WebViewer
import WebViewer from '@pdftron/pdfjs-express'
const element = document.getElementById('viewer');
WebViewer({
path: '/public', // point to where the files you copied are served from
initialDoc: 'https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_about.pdf' // path to your document
}, element).then((instance) => {
// Call APIs here
})
Documentation
Full documentation for PDFJS Express can be found here.