Introduction - MuPDF WebViewer

Initialization

The MuPDF WebViewer API can only be accessed after initializing with initMuPDFWebViewer(). This should return a mupdfwv.MuPDFWebViewer object to your code base or an error if there is any problem with the initialization.

initMuPDFWebViewer

initMuPDFWebViewer(selector: string, docURL: string, options: {     licenseKey: string,      libraryPath?: string,     filename?: string,     standalone?: boolean,     withoutLoader?: boolean   }): Promise<mupdfwv.MuPDFWebViewer>()

Arguments:
- selector – (required) A string which targets the dedicated <div> with the expected id.
- docURL – (required) The URL of the document you wish to display.
- options – (required) An object containing:
  - licenseKey - (required) string The license key for use.
  - libraryPath - (optional) string Library path for library assets
    See also Deploying with React for more on libraryPath and server side deployment.
  - filename - (optional) string Filename for PDF
  - standalone - (optional) boolean Standalone or not.
  - withoutLoader - (optional) boolean Whether to show the document loader or not.
Returns: Promise object as Promise<mupdfwv.MuPDFWebViewer>.

Example

import { initMuPDFWebViewer } from 'mupdf-webviewer'

initMuPDFWebViewer('#viewer', 'sample.pdf', {
  libraryPath: 'lib',
  licenseKey: 'YOUR_LICENSE_KEY',
})
  .then(mupdf => {
    /* Returns a mupdfwv.MuPDFWebViewer object for our API access */
    mupdf.toast.show({ type: 'success', content: 'Opened' });
  })
  .catch(err => {
    /* Error handling */
    console.log(err);
  });