@bundled-es-modules/pdfjs-dist

pdfjs-dist

This is a mirror of pdfjs-dist, bundled and exposed as an ES module

Install

npm install @bundled-es-modules/pdfjs-dist

Use

import pdfjs from "@bundled-es-modules/pdfjs-dist/build/pdf";
import viewer from "@bundled-es-modules/pdfjs-dist/web/pdf_viewer";

pdfjs.GlobalWorkerOptions.workerSrc =
  "@bundled-es-modules/pdfjs-dist/build/pdf.worker.js";

var url = "basicapi.pdf";
var loadingTask = pdfjs.getDocument(url);
//...

Important: Unlike in the original build, the pdfjs.GlobalWorkerOptions.workerSrc is mandatory. We recommend supplying the worker via CDN.

Overview

Structure

├── build/
│   ├── pdf.js                    - display layer
│   └── pdf.worker.js             - core layer
|── types/                        - typescript typings
└── web/
    ├── pdf_viewer.js             - top-level viewer import, containing all necessary setup
    ├── module.js                 - pdf-viewer module, transformed from UMD to ESM
    └── util.js                   - utility module for setup

Background

PDFJS is a library by Mozilla, created to facillitate client-side rendering of PDF documents.

Currently, the primary build for this project is provided as UMD-style modules at pdfjs/pdfjs-dist.

Support for es modules in the main project has been requested here (#10317)

Building

npm i
npm run build

Changelog

v3.6.172-alpha.1

• Major release, potentially w/ breaking changes
• See pdfjs release notes for releases since the last one published herein. Pay particularly close attention to "major" and "breaking" annotated items, especialy in the first 3.x.x release below:
  • https://github.com/mozilla/pdf.js/releases/tag/v3.0.279
  • https://github.com/mozilla/pdf.js/releases/tag/v3.1.81
  • https://github.com/mozilla/pdf.js/releases/tag/v3.2.146
  • https://github.com/mozilla/pdf.js/releases/tag/v3.3.122
  • https://github.com/mozilla/pdf.js/releases/tag/v3.4.120
  • https://github.com/mozilla/pdf.js/releases/tag/v3.5.141
  • https://github.com/mozilla/pdf.js/releases/tag/v3.6.172
• Potentially breaking for typescript consumers: vending types
  • pdfjs dist has started vending types, those are re-exported here
• Stopped publishing src/ and demo to npm