cdea75dc39
When the user edits the URL and changes the reference fragment (hash), PDF.js intercepts this action, and saves the then-current history state in the previous history entry. This is implemented by navigating back, editing the history and navigating forward again. The current logic has a flaw: It assumes that calling history.back() and history.forward() immediately updates the history state. This is however not guaranteed by the web standards, which states that calling e.g. history.back "must traverse the history by a delta -1", which means that the browser must QUEUE a task to traverse the session history, per spec: http://w3.org/TR/2011/WD-html5-20110113/history.html#dom-history-back https://html.spec.whatwg.org/multipage/browsers.html#dom-history-back Firefox and Internet Explorer deviate from the standards by immediately changing the history state instead of queuing the navigation. WebKit derived browsers (Chrome, Opera, Safari) and Opera presto do not. The user-visible consequence of strictly adhering to the standards in PDF.js can be shown as follows: 1. Edit the URL. 2. Append #page=2 for example. 3. Press Enter. -> Presto and WebKit: PDF.js reverts to the previous URL. -> Gecko and Trident: PDF.js keeps the new URL, as expected. To fix the issue, modification of the previous history item happens in a few asynchronous steps, guided by the popstate event to detect when the history navigation request has been committed. -- Some more implementation notes: I have removed the preventDefault and stopPropagation calls, because popstate is not cancelable, and window is already the last target of the event propagation. The previous allowHashChange logic was hard to follow, because it did not explain that hashchange will be called twice; once during the popstate handler for history.back() (which will reset allowHashChange), and again for history.forward() (where allowHashChange will be false). The purpose of allowHashChange is now more explicit, by incorporating the logic in the replacePreviousHistoryState helper function. |
||
|---|---|---|
| docs | ||
| examples | ||
| extensions | ||
| external | ||
| l10n | ||
| src | ||
| test | ||
| web | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .jshintignore | ||
| .jshintrc | ||
| .travis.yml | ||
| AUTHORS | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| make.js | ||
| package.json | ||
| pdfjs.config | ||
| 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 > Extensionand 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