Synopsis

PDFv.js is an open source PDF viewer written in TypeScript.

Motivation

The goal of this library is to provide an easy way to display pdf documents in the browser.

Installation

$ npm install @lcluber/pdfvjs

Or download it here.

Usage

ES6

Include 'node-modules/@lcluber/pdfvjs/dist/pdf.min.js' before PDFv.js ES6 module when you create your bundle for the web.

<canvas id="pdfViewer"></canvas>

import { Viewer } from '@lcluber/pdfvjs';

let viewer = new Viewer();
viewer.getDocument('./pdf/test.pdf').then(()=> {
  viewer.display('pdfViewer', viewer.numPages);// render the last page of the document
});

ES5

<script src="node-modules/@lcluber/pdfvjs/dist/pdfv.iife.min.js"></script>
<canvas id="pdfViewer"></canvas>

var viewer = new PDFv.Viewer();
viewer.getDocument('./pdf/test.pdf').then(function() {
  viewer.display('pdfViewer', viewer.numPages);// render the last page of the document
});

Demo

See a basic example here.

API Reference

Read the documentation here.

Tests

No tests to run yet

Contributors

PDFv.js is still in early development and I would be glad to get all the help you can provide for this project. To contribute you can clone the project on GitHub and See NOTICE.md for detailed installation walkthrough.

License

MIT License

Copyright (c) 2018 Ludovic CLUBER

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.