This issue is actually, in a sense, "caused" by the fact that the API/viewer supports partial loading/rendering. Previously when the *entire* document was always fetched before rendering begun, we knew all page sizes in advance and this issue didn't exist. Now we use the size of *one* page in order to set the initial size of every page, until we've fetched the pages and thus know their correct sizes. This means that during loading the size of the pages can change, which may cause the initial position to become scrolled out of view. The most naive solution to this problem would perhaps be to delay setting the initial position on load for all documents, until all pages are fetched. However I think that would be a *really* bad idea, since doing so would make the initial rendering slower and make it feel sluggish for most documents. Since there is generally no way of knowing if a document has different sized pages prior to loading it, we can only check once the pages are available. Hence this patch, which treats documents with different sized pages as a special case, by re-applying the initial position when all pages have become available. |
10 years ago | |
---|---|---|
docs | Update README.md with shorter clone command and improved instruction order | 10 years ago |
examples | Add a couple of CSS hacks in order for `scrollIntoView` to work in the "simpleviewer" component example | 10 years ago |
extensions | Merge pull request #6233 from Rob--W/crx-local-files | 10 years ago |
external | Fix preprocessor: nesting, error & tests | 10 years ago |
l10n | Add locatization notes for the DocumentProperties strings with parameters | 10 years ago |
src | Merge pull request #6407 from Snuffleupagus/bug-1200096 | 10 years ago |
test | Merge pull request #6407 from Snuffleupagus/bug-1200096 | 10 years ago |
web | For documents with different page sizes, ensure that the correct page becomes visible on load when e.g. the 'page' hash parameter was provided (bug 1191279, issue 6393) | 10 years ago |
.gitattributes | Update .gitattributes to fix GitHub file type detection for JavaScript. | 10 years ago |
.gitignore | Added svg export tool | 11 years ago |
.gitmodules | Update fonttools location and version (issue 6223) | 10 years ago |
.jshintignore | Exclude B2G stubs from linting | 11 years ago |
.jshintrc | Enforce strict equalities with JSHint | 11 years ago |
.travis.yml | Attempt to fix Travis | 11 years ago |
AUTHORS | Add fkaelberer to the list of authors | 11 years ago |
CONTRIBUTING.md | Clarify bug reporting with regards to providing a pdf | 10 years ago |
LICENSE | cleaned whitespace | 10 years ago |
README.md | Update README (Chrome & Opera section) | 10 years ago |
make.js | Set TZ=UTC before calls to zip | 10 years ago |
package.json | Improve robustness of builder (esp. on Windows) | 10 years ago |
pdfjs.config | Version 1.1.366 | 10 years ago |
README.md
PDF.js
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 checkout:
- Issue Reporting Guide
- Code Contribution Guide
- Frequently Asked Questions
- Good Beginner Bugs
- Priorities
- Attend a Public Meeting
For further questions or guidance feel free to stop by #pdfjs on irc.mozilla.org.
Getting Started
Online demo
Browser Extensions
Firefox
PDF.js is built into version 19+ of Firefox, however one extension is still available:
- Development Version - This version is updated every time new code is merged into the PDF.js codebase. This should be quite stable but still might break from time to time.
Chrome and Opera
- The official extension for Chrome can be installed from the Chrome Web Store. This extension is maintained by @Rob--W.
- Opera has also published an extension for their browser at the Opera add-ons catalog.
- Build Your Own - Get the code as explained below and issue
node make chromium
. Then open Chrome, go toTools > Extension
and load the (unpackaged) extension from the directorybuild/chromium
.
Getting the Code
To get a local copy of the current code, clone it using git:
$ git clone git://github.com/mozilla/pdf.js.git
$ cd pdf.js
Next, install Node.js via the official package or via nvm. If everything worked out, run
$ npm install
to install all dependencies for PDF.js.
Finally you need to start a local web server as some browsers do not allow opening PDF files using a file:// URL. Run
$ node make server
and then you can open
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 productions scripts and build the generic
viewer, issue:
$ node make 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
. If you want to support more browsers than Firefox you'll also need
to include compatibility.js
from build/generic/web/
. The PDF.js files are large and
should be minified for production.
Learning
You can play with the PDF.js API directly from your browser through the live demos below:
The repo contains a hello world example that you can run locally:
For an introduction to the PDF.js code, check out the presentation by our contributor Julian Viereck:
You can read more about PDF.js here:
- http://andreasgal.com/2011/06/15/pdf-js/
- http://blog.mozilla.com/cjones/2011/06/15/overview-of-pdf-js-guts/
Even more learning resources can be found at:
Questions
Check out our FAQs and get answers to common questions:
Talk to us on IRC:
- #pdfjs on irc.mozilla.org
Join our mailing list:
Subscribe either using lists.mozilla.org or Google Groups:
- https://lists.mozilla.org/listinfo/dev-pdf-js
- https://groups.google.com/group/mozilla.dev.pdf-js/topics
Follow us on twitter: @pdfjs
Weekly Public Meetings