Skip to content
PDF Reader in JavaScript
JavaScript CSS HTML
Branch: master
Clone or download

Latest commit

timvandermeij Merge pull request #11927 from timvandermeij/svg-fill-opacity-shading
Implement fill opacity for shading patterns in the SVG back-end
Latest commit 9d38dd4 May 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update links from IRC to Matrix. Feb 28, 2020
docs Update the getting started page of the website for the new release Mar 19, 2020
examples [api-minor] Decode all JPEG images with the built-in PDF.js decoder i… May 21, 2020
extensions Update Prettier to version 2.0 Apr 14, 2020
external Reduce usage of SystemJS, in the development viewer, even further May 20, 2020
l10n Update l10n files May 16, 2020
src Implement fill opacity for shading patterns in the SVG back-end May 24, 2020
test Merge pull request #11601 from Snuffleupagus/rm-nativeImageDecoderSup… May 23, 2020
web [api-minor] Remove the `disableCreateObjectURL` option from the `getD… May 21, 2020
.editorconfig Uses editorconfig to maintain consistent coding styles Nov 14, 2015
.eslintignore Replace the bundled `ReadableStream` polyfill with the `web-streams-p… Sep 23, 2019
.eslintrc Reduce usage of SystemJS, in the development viewer, even further May 20, 2020
.gitattributes Fixing C++,PHP and Pascal presence in the repo Oct 29, 2015
.gitignore Include `package-lock.json` for reproducible builds Jun 2, 2018
.gitmodules Update fonttools location and version (issue 6223) Jul 17, 2015
.gitpod.Dockerfile Simplifies code contributions by automating the dev setup with gitpod.io Nov 6, 2019
.gitpod.yml Simplifies code contributions by automating the dev setup with gitpod.io Nov 6, 2019
.mailmap Add mgol's name to AUTHORS, add .mailmap Nov 22, 2017
.prettierrc Update Prettier to version 2.0 Apr 14, 2020
.travis.yml Use Node LTS releases to fix Travis CI builds (issue 10790) Apr 21, 2020
AUTHORS Add SehyunPark to AUTHORS Nov 29, 2017
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file Mar 28, 2019
EXPORT Adds ECCN response statement Oct 23, 2017
LICENSE cleaned whitespace Feb 17, 2015
README.md Remove any mention of Gitpod from the README (issue 11732) Apr 11, 2020
gulpfile.js Stop building any `src/` files during the `gulp default_preferences` … May 21, 2020
package-lock.json Reduce usage of SystemJS, in the development viewer, even further May 20, 2020
package.json Reduce usage of SystemJS, in the development viewer, even further May 20, 2020
pdfjs.config Bump versions in `pdfjs.config` Mar 19, 2020
systemjs.config.js docs: Fix simple typo, occurences -> occurrences Apr 17, 2020

README.md

PDF.js Build Status

PDF.js is a Portable Document Format (PDF) viewer that is built with HTML5.

PDF.js is community-driven and supported by Mozilla Labs. Our goal is to create a general-purpose, web standards-based platform for parsing and rendering PDFs.

Contributing

PDF.js is an open source project and always looking for more contributors. To get involved, visit:

Feel free to stop by our Matrix room for questions or guidance.

Getting Started

Online demo

Please note that the "Modern browsers" version assumes native support for features such as e.g. async/await, Promise, and ReadableStream.

Browser Extensions

Firefox

PDF.js is built into version 19+ of Firefox.

Chrome

  • The official extension for Chrome can be installed from the Chrome Web Store. This extension is maintained by @Rob--W.
  • Build Your Own - Get the code as explained below and issue gulp chromium. Then open Chrome, go to Tools > Extension and load the (unpackaged) extension from the directory build/chromium.

Getting the Code

To get a local copy of the current code, clone it using git:

$ git clone https://github.com/mozilla/pdf.js.git
$ cd pdf.js

Next, install Node.js via the official package or via nvm. You need to install the gulp package globally (see also gulp's getting started):

$ npm install -g gulp-cli

If everything worked out, install all dependencies for PDF.js:

$ npm install

Finally, you need to start a local web server as some browsers do not allow opening PDF files using a file:// URL. Run:

$ gulp server

and then you can open:

Please keep in mind that this requires an ES6 compatible browser; refer to Building PDF.js for usage with older browsers.

It is also possible to view all test PDF files on the right side by opening:

Building PDF.js

In order to bundle all src/ files into two production scripts and build the generic viewer, run:

$ gulp generic

This will generate pdf.js and pdf.worker.js in the build/generic/build/ directory. Both scripts are needed but only pdf.js needs to be included since pdf.worker.js will be loaded by pdf.js. The PDF.js files are large and should be minified for production.

Using PDF.js in a web application

To use PDF.js in a web application you can choose to use a pre-built version of the library or to build it from source. We supply pre-built versions for usage with NPM and Bower under the pdfjs-dist name. For more information and examples please refer to the wiki page on this subject.

Including via a CDN

PDF.js is hosted on several free CDNs:

Learning

You can play with the PDF.js API directly from your browser using the live demos below:

More examples can be found in the examples folder. Some of them are using the pdfjs-dist package, which can be built and installed in this repo directory via gulp dist-install command.

For an introduction to the PDF.js code, check out the presentation by our contributor Julian Viereck:

More learning resources can be found at:

The API documentation can be found at:

Questions

Check out our FAQs and get answers to common questions:

Talk to us on Matrix:

File an issue:

Follow us on twitter: @pdfjs

You can’t perform that action at this time.