finna-pdf-viewer v1.0.1

finna-pdf-viewer

Features

• Searching
• Printing
• Sidebar with thumbails, outlines, and attachments
• Rotating
• Download and upload
• Zoom
• Full-screen mode
• various selection tools
• standard display or even / odd spreads (like a book)
• various approaches to scrolling (vertical, horizontal, "wrapped" scrolling)
• Internationalization (providing translations to several dozen languages)
• plus the ability to deactivate each of these features.

Not to mention the ability to display PDF files, running on Mozilla's pdf.js 2.1.266.

Compatibility to Bootstrap (and other CSS frameworks)

Bootstrap interferes with the printing algorithm of pdf.js. Guard it with a media query to avoid unwanted effects, such as scaling the print to 65%. For example, if you're using SCSS and Bootstrap 4, remove the import of Bootstrap.min.css from the Angular.json file. Instead, import it by including Bootstrap by adding this line to the global styles.scss file:

@media screen {
  @import '../node_modules/bootstrap/scss/bootstrap';
}

## How to use the library



1.  Install the library with npm i finna-pdf-viewer --save
2.  Open the file "angular.json" (or ".angular-cli.json" if you're using an older version of Angular)
    and add these three JavaScript files to the "scripts" section:

            "scripts": [
              "node_modules/finna-pdf-viewer/assets/pdf.js",
              "node_modules/finna-pdf-viewer/assets/pdf.worker.js",
              "node_modules/finna-pdf-viewer/assets/viewer.js"
            ]

3.  Add the translations to the assets by adding them to the "assets" section in the angular.json:

            "assets": [
              "src/favicon.ico",
              "src/assets",
              {
                "glob": "**/*",
                "input": "node_modules/finna-pdf-viewer/assets/locale",
                "output": "/assets/locale/"
              }
            ]

    If you need only one language, you can reduce the list to 'locale.properties' and your language folder.

    _Hint:_ There are two ways to define the language files needed for the labels of the buttons and screen elements of the PDF viewer. The second method is described below in the "internationalization" section.

4.  Add "FinnaPdfViewerModule" to the import section of your module file. If your IDE doesn't find
    the import automatically, here it is:

          Finna } from 'finna-pdf-viewer';

5.  Now you can display the PDF file like so:

```html
<finna-pdf-viewer [src]="'assets/example.pdf'" useBrowserLocale="true"> </finna-pdf-viewer>

6. If you want to display a PDF file you've downloaded from a server, you probably have a Blob instead of an URL. You can simply use URL.createObjectURL() to convert this Blob into something the PDF viewer can display:

<finna-pdf-viewer [src]="currentPdf"></finna-pdf-viewer>

public currentPdf: DOMString = null;

set src(input: Blob) {
  this.currentPdf = URL.createObjectURL(input);
}

Configuration

Legend:

• (attribute) attribute with two-way-binding
• attribute PDF-viewer reacts when the attribute changes
• attribute attribute is used at load time only (subsequent changes are ignored)

Internationalization

Slow default way

If you add the translation files to your project as described above in step 3, the PDF viewer uses the browser language setting to determine which language to load. First, it loads the locale.properties, scans it for the desired language files, and loads the language file from the corresponding folder. That's two additional (and even consecutive) HTTP calls. That's slow, and it may even lead to errors if the network is already congested loading other resource files.

Don't forget to set the attribute useBrowserLocale="true" if you follow this approach.

Slow way with custom translation files

If you want to use the slow way, but prefer to load the language files from a different URL, add a link to your application like so:

<link rel="resource" type="application/l10n" href="https://www.example.com/locale/locale.properties" />

In this case, don't set useBrowserLocale (or set it explicitely to false).

Inlining (aka embedding) the language files

Alternatively, you can provide the translations as a Json file. This Json file has to be part of the HTML page, like so:

<script type="application/l10n">
  {"default_locale":"de","locales":{"de": ... }}
</script>

Hint: Sometimes you need to copy the HTML snippet into the index.html at the root folder of the Angular project. The bottom line is that the HTML snippet is already part of the DOM when the PDF viewer is initialized. Cluttering the root index file with the translations is an ugly and inflexible hack, but it works.

If you're using the "inline" approach, don't set useBrowserLocale (or set it explicitely to false).

Troubleshooting

License

The library is based on https://github.com/mozilla/pdf.js, which has been published under an Apache V2 license.