pdfjs-viewer-element

pdfjs-viewer-element

A web component for viewing pdf files in the browser. The package is based on PDF.js default viewer build and works with any framework.

⚠️ pdfjs-viewer-element uses PDF.js prebuilt, that includes the generic build of PDF.js and the viewer. To use the package you should download and place the prebuilt files to some directory of your project. Then specify the path to this directory with viewer-path property (/pdfjs by default).

Status

Docs

Getting started

Api

Install

Using module bundlers:

# With npm
npm install pdfjs-viewer-element
# With yarn
yarn add pdfjs-viewer-element

import 'pdfjs-viewer-element'

Using browser:

<script type="module" src="https://cdn.skypack.dev/pdfjs-viewer-element"></script>

Usage

<pdfjs-viewer-element src="/file.pdf" viewer-path="/path-to-viewer"></pdfjs-viewer-element>

Properties

src - Path to pdf file

viewer-path - Path to PDF.js prebuilt

locale - Language of the interface

page - Page number

search - Search text

phrase - Search by phrase

zoom - Zoom level

pagemode - Page mode

For more clarity, see the Api docs page.

License

For this package - MIT.

For the pdf.js library - https://github.com/mozilla/pdf.js/blob/master/LICENSE.