Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
16,612 Commits 1 Branch 80 Tags 254 MiB
JavaScript 79.4%
Fluent 18.3%
CSS 1.5%
HTML 0.8%
4c78290028
Go to file
Jonas Jenwald 4c78290028 [api-minor] Remove the textHighlighterFactory in the viewer 
Please note that this functionality has never really mattered for the Firefox PDF Viewer, the GENERIC viewer, or even the "simpleviewer"/"singlepageviewer" component-examples. Hence, in practice this means that only the "pageviewer" component-example[1] have ever really utilized this.

Using factories to initialize various layers in the viewer, rather than simply invoking the relevant code directly, seems (at least to me) like a somewhat roundabout way of doing things.
Not only does this lead to more code, both to write and maintain, but since many of the layers have common parameters (e.g. an `AnnotationStorage`-instance) there's also some duplication.

Hence this patch, which removes the `textHighlighterFactory` and instead uses a lookup-function in the `PDFPageView`-class to access the external viewer-properties as necessary.
Note that this should even be an improvement for the "pageviewer" component-example, since most layers will now work by default rather than require manual configuration.

---
[1] In practice we generally suggest using the "simpleviewer", or "singlepageviewer", since it does *most* things out-of-the-box and given that a lot of functionality really require *a viewer* and not just a single page in order to work.
2022-12-18 13:26:10 +01:00
.github Stop Dependabot from creating its own, otherwise unused, labels 2022-11-14 15:07:55 +01:00
docs Reference supported browsers Wiki-page in more README files 2022-09-23 11:06:47 +02:00
examples Remove the enableScripting-parameter from the component examples (PR 13816 follow-up) 2022-09-16 10:19:05 +02:00
extensions Tighten the vars-argument for the ESLint no-unused-vars rule 2022-12-04 16:15:50 +01:00
external [api-minor] Use new Worker() syntax in webpack entrypoint 2022-09-13 11:12:00 -04:00
l10n Update l10n files 2022-11-27 10:22:14 +01:00
src [api-minor] Move, most of, the isPureXfa-handling from PDFViewer and into PDFPageView 2022-12-18 13:10:23 +01:00
test Strip out a reserved operator (9) from CFF char strings (fixes issue #15784) 2022-12-16 15:17:46 +01:00
web [api-minor] Remove the textHighlighterFactory in the viewer 2022-12-18 13:26:10 +01: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 Tighten the vars-argument for the ESLint no-unused-vars rule 2022-12-04 16:15:50 +01: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 Enable the Stylelint shorthand-property-no-redundant-values rule 2021-01-22 14:36:02 +01: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.js [GV] Add a viewer for GeckoView 2022-12-15 13:39:48 +01:00
LICENSE cleaned whitespace 2015-02-17 11:07:37 -05:00
package-lock.json Bump decode-uri-component from 0.2.0 to 0.2.2 2022-12-02 04:48:04 +00:00
package.json Update npm packages 2022-11-27 10:18:30 +01:00
pdfjs.config Bump versions in pdfjs.config 2022-11-26 14:52:56 +01:00
README.md Changed link for "Gulp's getting started guide" 2022-10-30 15:30:42 -07:00
systemjs.config.js Enable the no-typeof-undefined ESLint plugin rule 2022-12-01 18:20:39 +01: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 features such as optional chaining, nullish coalescing, and private class fields/methods; please also see this wiki page.

Browser Extensions

Firefox

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

Chrome

  • 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 a modern and fully up-to-date browser; 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:

Follow us on Twitter: @pdfjs