Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
11,132 Commits 1 Branch 80 Tags 254 MiB
JavaScript 79.4%
Fluent 18.3%
CSS 1.5%
HTML 0.8%
2ed3591b22
Go to file
Jonas Jenwald 2ed3591b22 Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called 
*This patch is based on something that I noticed while working on PR 10126.*

The recent re-factoring of `PDFFindController` brought many improvements, among those the fact that access to `BaseViewer` is no longer required. However, with these changes there's one thing which now strikes me as not particularly user-friendly[1]: The fact that in order for searching to actually work, `PDFFindController.setDocument` must be called *and* a 'pagesinit' event must be dispatched (from somewhere).

For all other viewer components, calling the `setDocument` method[2] is enough in order for the component to actually be usable.
The `PDFFindController` thus stands out quite a bit, and it also becomes difficult to work with in any sort of custom implementation. For example: Imagine someone trying to use `PDFFindController` separately from the viewer[3], which *should* now be relatively simple given the re-factoring, and thus having to (somehow) figure out that they'll also need to manually dispatch a 'pagesinit' event for searching to work.

Note that the above even affects the unit-tests, where an out-of-place 'pagesinit' event is being used.
To attempt to address these problems, I'm thus suggesting that *only* `setDocument` should be used to indicate that searching may start. For the default viewer and/or the viewer components, `BaseViewer.setDocument` will now call `PDFFindController.setDocument` when the document is ready, thus requiring no outside configuration anymore[4]. For custom implementation, and the unit-tests, it's now as simple as just calling `PDFFindController.setDocument` to allow searching to start.

---
[1] I should have caught this during review of PR 10099, but unfortunately it's sometimes not until you actually work with the code in question that things like these become clear.

[2] Assuming, obviously, that the viewer component in question actually implements such a method :-)

[3] There's even a very recent issue, filed by someone trying to do just that.

[4] Short of providing a `PDFFindController` instance when creating a `BaseViewer` instance, of course.
2018-10-04 10:28:50 +02:00
.github Attempt to clarify the meaning of "extension" in the ISSUE_TEMPLATE 2017-10-21 11:32:03 +02:00
docs Replace String.prototype.substr() occurrences with String.prototype.substring() 2018-09-28 11:41:07 +02:00
examples Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called 2018-10-04 10:28:50 +02:00
extensions Add general support for re-dispatching events, on EventBus instances, to the DOM 2018-08-30 17:28:12 +02:00
external Replace String.prototype.substr() occurrences with String.prototype.substring() 2018-09-28 11:41:07 +02:00
l10n Update translations 2018-09-30 15:50:12 +02:00
src Merge pull request #10119 from Snuffleupagus/rm-onFileAttachmentAnnotation 2018-10-02 23:25:22 +02:00
test Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called 2018-10-04 10:28:50 +02:00
web Make PDFFindController less confusing to use, by allowing searching to start when setDocument is called 2018-10-04 10:28:50 +02:00
.editorconfig Uses editorconfig to maintain consistent coding styles 2015-11-14 07:32:18 +05:30
.eslintignore Adds streams-lib polyfill and exports ReadableStream from shared/util. 2017-05-20 00:26:34 +05:30
.eslintrc Simplify the "spaced-comment" ESLint rule 2018-09-09 11:58:32 +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
.mailmap Add mgol's name to AUTHORS, add .mailmap 2017-11-22 10:46:11 +01:00
.travis.yml Travis CI: use most recent version of NPM 2016-10-27 21:10:19 +02:00
AUTHORS Add SehyunPark to AUTHORS 2017-11-29 22:24:08 +09:00
EXPORT Adds ECCN response statement 2017-10-23 13:31:36 -05:00
gulpfile.js Ensure that the built PdfJsDefaultPreferences.jsm file won't be affected/touched during tree-wide ESLint rule changes in mozilla-central (PR 9571 follow-up) 2018-08-28 23:46:54 +02:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Update packages 2018-09-30 15:45:10 +02:00
package.json Update packages 2018-09-30 15:45:10 +02:00
pdfjs.config Version 2.0 2017-10-30 08:18:25 -05:00
README.md Use HTTPS for links in README.md 2018-09-09 17:57:12 +02:00
systemjs.config.js Provide custom messages for the no-restricted-globals ESLint rule, and refactor the .eslintrc files (PR 9868 follow-up) 2018-07-23 14:10:13 +02:00

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, visit:

Feel free to stop by #pdfjs on irc.mozilla.org for questions or guidance.

Getting Started

Online demo

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:

Questions

Check out our FAQs and get answers to common questions:

Talk to us on IRC (Internet Relay Chat):

  • #pdfjs on irc.mozilla.org

File an issue:

Follow us on twitter: @pdfjs