pdfjs-viewer-element

pdfjs-viewer-element

A custom element, based on PDF.js default viewer. Supported in all major browsers and works with most JS frameworks. See examples of usage in the different frameworks.

⚠️ pdfjs-viewer-element requires 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

Live examples

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 - PDF file URL, should refer to the same origin

viewer-path - Path to PDF.js prebuilt

locale - Specifies which language to use in the viewer UI. For a list of the available locales, see all l10n files

text-layer - Text layer, that is used for text selection

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

MIT.