MuPDF WebViewer

A customizable PDF Viewer Component for the Web.

MuPDF WebViewer is an easy to use drop-in UI component for web pages which allows for in-context PDF viewing, data extraction, customization and more.

This README is a short overview. For the full documentation, see the Docs.

Quick links

• Docs: WebViewer Developer Documentation
• Homepage: webviewer.mupdf.com
• Samples:
  • Vanilla JS: mupdf-webviewer-vanilla-js-sample
  • React: mupdf-webviewer-react-sample
  • Vue: mupdf-webviewer-vue-sample
  • Angular: mupdf-webviewer-angular-sample
• Changelog: Changelog

Installation

npm install mupdf-webviewer

Quick start

<div id="viewer"></div>

import { initMuPDFWebViewer } from 'mupdf-webviewer'

initMuPDFWebViewer('#viewer', 'sample.pdf')

initMuPDFWebViewer() returns a Promise<MuPDFWebViewer> (use it if you need to access the viewer instance/API).

Common options

• libraryPath: Base URL for viewer runtime resources (see Docs)
• licenseKey: License key for trial/commercial usage

API Reference

License

• Free License (v0.6.0+): view-only (with restrictions)
• Trial/Commercial: full features
• Local Environment (development) (v0.11.0+)
  • License verification calls are disabled on localhost (including 127.0.0.1, *.test) to eliminate unnecessary network I/O during local development. This reduces startup latency and allows offline development. This behavior is available in v0.11.0+ only.

Support

• Issues/Bugs: [email protected]