mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-19 14:48:08 +02:00
Code Activity
PDF Reader in JavaScript
17671 commits 1 branch 93 tags 292 MiB
Find a file
Jonas Jenwald 42e6243ebf Attempt to expose e.g. pdfjsLib globally regardless of how the library is imported (issue 16778) 
We obviously don't want to re-introduce any `require` usage in e.g. the viewer, since we should strive to only use native `import` statements wherever possible.[1]
Hopefully exposing e.g. the library globally in more cases won't break anything, however it's somewhat difficult for me to imagine all the ways in which third-party users may be accessing the PDF.js library. (Given the lack of a runnable test-case in the issue, I also cannot guarantee that this is enough to fully address the problem.)

---
[1] Ideally we should probably not rely on e.g. `pdfjsLib` being globally available in the *built* viewer, and rather always `import` the library instead.
Unfortunately this would require larger (possibly breaking) changes in the builds that we provide, however note that Firefox only recently got support for `import` in workers and that Webpack still only have *experimental* support for outputting "proper" modules.
2023-08-03 12:53:27 +02:00
.github Merge pull request #16370 from Snuffleupagus/publish-website-only-master 2023-04-29 11:36:33 +02:00
docs Allow, optionally, using worker-modules during local development 2023-01-31 12:09:44 +01:00
examples [api-minor] Replace the useOnlyCssZoom option with maxCanvasPixels = 0 instead (PR 16729 follow-up) 2023-07-29 13:58:03 +02:00
extensions Remove the useOnlyCssZoom preference 2023-07-23 11:20:36 +02:00
external Enable the no-lonely-if ESLint rule 2023-07-21 20:10:44 +02:00
l10n Merge pull request #16726 from calixteman/gv_fix_dl_button 2023-07-24 09:54:41 +02:00
src [Editor] Use a getter and not a function for the _checkIfSVGFitsInCanvas (bug 1846727) 2023-08-03 09:46:31 +02:00
test [api-minor] Deprecate the PDFDocumentProxy.getJavaScript method 2023-08-01 09:02:05 +02:00
web Merge pull request #16779 from Snuffleupagus/deprecate-getJavaScript 2023-08-01 20:58:36 +02:00
.editorconfig Ensure that the EditorConfig rules apply to *.json and *.pdf.link files as well 2021-10-15 13:46:11 +02:00
.eslintignore Include the test/resources/ folder when running ESLint/Stylelint 2021-08-04 13:50:44 +02:00
.eslintrc Enable the unicorn/prefer-ternary ESLint plugin rule 2023-07-27 09:18:26 +02:00
.gitattributes Fixing C++,PHP and Pascal presence in the repo 2015-10-29 13:03:51 -05:00
.gitignore Include package-lock.json for reproducible builds 2018-06-02 20:29:47 +02:00
.gitmodules Update fonttools location and version (issue 6223) 2015-07-17 12:51:09 +02:00
.gitpod.Dockerfile Simplifies code contributions by automating the dev setup with gitpod.io 2019-11-06 04:12:19 +00:00
.gitpod.yml Simplifies code contributions by automating the dev setup with gitpod.io 2019-11-06 04:12:19 +00:00
.mailmap Add mgol's name to AUTHORS, add .mailmap 2017-11-22 10:46:11 +01:00
.prettierrc Update Prettier to version 2.0 2020-04-14 12:28:14 +02:00
.stylelintignore Include the test/resources/ folder when running ESLint/Stylelint 2021-08-04 13:50:44 +02:00
.stylelintrc Enforce double-colon notation for CSS pseudo-elements 2023-04-18 15:50:22 +02:00
AUTHORS Add SehyunPark to AUTHORS 2017-11-29 22:24:08 +09:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-27 21:00:01 -07:00
EXPORT Adds ECCN response statement 2017-10-23 13:31:36 -05:00
gulpfile.mjs Attempt to expose e.g. pdfjsLib globally regardless of how the library is imported (issue 16778) 2023-08-03 12:53:27 +02:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Remove the vinyl-fs dependency 2023-07-23 18:33:20 +02:00
package.json Remove the vinyl-fs dependency 2023-07-23 18:33:20 +02:00
pdfjs.config Fix typo in the baseVersion commit hash (PR 16769 follow-up) 2023-07-30 15:21:49 +02:00
README.md Tweak the README slightly 2023-07-04 11:32:25 +02:00

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. 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 the latest JavaScript features; please also see this wiki page.

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 assumes the latest version of Mozilla Firefox; refer to Building PDF.js for non-development usage of the PDF.js library.

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

If you need to support older browsers, run:

$ gulp generic-legacy

This will generate pdf.js and pdf.worker.js in the build/generic/build/ directory (respectively build/generic-legacy/build/). 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: