ngx-pdfjs-viewer

This is a extended version of pdf viewer from https://www.npmjs.com/package/ng2-pdfjs-viewer

Usage no npm install needed!

<script type="module">
  import ngxPdfjsViewer from 'https://cdn.skypack.dev/ngx-pdfjs-viewer';
</script>

README

Angular pdf viewer, supports Angular 2 - 10

This is a extended version of pdf viewer from https://www.npmjs.com/package/ng2-pdfjs-viewer

Below are the extra things we have in this version

  • Pinch Zoom
  • Latest version of PDF js

Installation

Step 1: Install ngx-pdfjs-viewer


  

$ npm install ngx-pdfjs-viewer --save

And then configure it in your Angular AppModule:


  

import { BrowserModule } from  '@angular/platform-browser';

  

import { NgModule } from  '@angular/core';

  

import { AppComponent } from  './app.component';

  

  

import { PdfJsViewerModule } from  'ngx-pdfjs-viewer'; // <-- Import PdfJsViewerModule module

  

  

@NgModule({

  

declarations: [

  

AppComponent,

  

],

  

imports: [

  

BrowserModule,

  

PdfJsViewerModule  // <-- Add to declarations

  

],

  

providers: [],

  

bootstrap: [AppComponent]

  

})

  

export  class  AppModule { }

Step 2: Copy task for pdfjs

For several advanced options to work, you need a copy of pdfjs from this npm package.

Edit your project's angular.json file and use ng build as described here https://angular.io/guide/workspace-config#project-asset-configuration


  

"assets": [

  

{ "glob": "**/*", "input": "node_modules/ngx-pdfjs-viewer/pdfjs", "output": "/assets/pdfjs" },

  

]

Please note, you may manually Copy node_modules\ngx-pdfjs-viewer\pdfjs to your public or asset folder or use any copy script as part of your build process. Another method could be to use TransferWebpackPlugin if you are using webpack(https://github.com/dkokorev90/transfer-webpack-plugin).

TransferWebpackPlugin Sample code


  

var  TransferWebpackPlugin = require('transfer-webpack-plugin');

  

...

  

plugins: [

  

new  TransferWebpackPlugin([

  

{ from:  'node_modules\ngx-pdfjs-viewer\pdfjs', to:  path.join(__dirname, 'assets') }

  

])

  

]

Please note if you decide to put pdfjs folder anywhere else other than the assets folder, make sure you also set [viewerFolder] property to help locate the folder.

Options

| Attribute | Description | Type | Default Value

| --- | --- | --- | --- |

| [pdfSrc] | Fully qualified path to pdf file. (For remote pdf urls over http/https, CORS should be enabled) | string | |

| PDFViewerApplication | This public property exposes underlying PDFViewerApplication object. Make sure to access it after document is loaded. Opens up the whole world of underlying PDFJS properties and methods. Use it to customize the viewer and document experience. | object | |

| PDFViewerApplicationOptions | This public property exposes underlying PDFViewerApplicationOptions object. Make sure to access it after document is loaded. Opens up the whole world of underlying PDFJS options. Use it to customize the viewer and document experience. | object | |

| [viewerFolder] | Set path to pdfjs's web and build folders. | string | assets folder path |

| [externalWindow] | Open in new tab. Set to true to open document in a new tab | boolean | false |

| externalWindowOptions | External window options. For allowed comma separated values, refer to https://developer.mozilla.org/en-US/docs/Web/API/Window/open | string | |

| (onDocumentLoad) | Event to be invoked once document is fully loaded(Must provide viewerId). Also returns number of pages in the $event parameter. E.g. (onDocumentLoad)="testPagesLoaded($event)"" | Function | |

| (onPageChange) | Event to be invoked when user scrolls through pages(Must provide viewerId). Also returns current page number user is at in the $event parameter. E.g. (onPageChange)="testPageChange($event)"" | Function | |

| (onBeforePrint) | Event to be invoked before document gets printed(Must provide viewerId). E.g. (onBeforePrint)="testBeforePrint()" | Function | |

| (onAfterPrint) | Event to be invoked after document gets printed(Must provide viewerId). E.g. (onAfterPrint)="testAfterPrint()" | Function | |

| downloadFileName | Sets/Changes the name of document to be downloaded. If the file name does not ends in .pdf, the component will automatically add it for you. | string | Actual name of the document |

| [page] | Show specific page. E.g page=3. You may also get/set the page number from your component using '.' notation explicitly, after document is loaded. E.g. myPdfViewer.page = 3; | number | 1 |

| [lastPage] | Show last page of the document once it is loaded(If set to true). If you use this option along with page option, undesired effects might occur | boolean | false |

| nameddest | Go to a named destination. E.g. To go to section 5.1 use like nameddest=5.1. Do not mix this option with page and lastPage options | string | |

| zoom | Set zoom level of document. Applicable values are auto, page-width, page-height, page-fit, 200(As a zoom percentage), left offset(As in "auto,18,827"), top offset(As in "auto,18,127") | string | auto |

| [print] | Show/hide print button. Set false to hide | boolean | true |

| [startPrint] | Start print preview of document. This combined with externalWindow could mimic a print preview functionality just like the one in gmail. | boolean | |

| [download] | Show/hide download button. Set false to hide | boolean | true |

| [find] | Show/hide search button. Set false to hide | boolean | true |

| [startDownload] | Download document as soon as it opens. You may put this to good use. | boolean | |

| [rotatecw] | Rotate document clock wise 90° | boolean | |

| [rotateccw] | Rotate document anti-clock wise 90° | boolean | |

| cursor | Type of cursor. Available options are HAND/H, SELECT/S,ZOOM/Z. Case is irrelevant. | SELECT/S | |

| scroll | Sets scroll. Available options are VERTICAL/V, HORIZONTAL/H,WRAPPED/W. Case is irrelevant. | VERTICAL/V | |

| spread | Sets Odd or Even spread. Available options are ODD/O, EVEN/E,NONE/N. Case is irrelevant. | NONE/N | |

| [fullScreen] | Show/hide presentation(full screen) button. Set false to hide | boolean | true |

| cursor | Type of cursor. Available options are HAND/H, SELECT/S,ZOOM/Z. Case is irrelevant. | SELECT/S | |

| pagemode | State of sidebar. Available options are none, thumbs,bookmarks,attachments. E.g. pagemode=attachments. | none | |

| [openFile] | Show/hide open file button. Set false to hide | boolean | true |

| [viewBookmark] | Show/hide bookmark button. Set false to hide | boolean | true |

| [showSpinner] | Show a simple css based spinner/progress before the document loads | boolean | true |

| locale | Set locale(language) of toolbar/buttons and other viewer elements. E.g. 'de-AT', 'en-GB' etc | string | browser's default language if present, otherwise en-US |

| [useOnlyCssZoom] | Instructs the viewer to use css based zoom. This will produce better zoom effect on mobile devices and tablets. | boolean | false |

| errorMessage | Custom error message | string | |

| [errorAppend] | Appends custom error message to the end of other pdfjs error messages | true |

| [errorOverride] | Overrides all pdfjs error messages and shows only user's custom error message | boolean | false |

| [diagnosticLogs] | Turns on all diagnostic logs to the console | boolean | true |

Please note, copy step is mandatory to enjoy all of the different options listed above. You may also avoid this step and could directly use https://github.com/mozilla/pdf.js/wiki/Setup-pdf.js-in-a-website if you wish to just use the default viewer

Usage

For your convenience a sample app using angular is available under this repository, if you would like to see it in action (Folder SampleApp). It shows many ways to configure this component for different needs.

Once your PdfJsViewerComponent is imported you can use it in your Angular application like this:


  

<!-- You can now use your library component in app.component.html -->

  

<h1>

  

{{title}}

  

</h1>

  

<ngx-pdfjs-viewer  pdfSrc="your pdf file path"></ngx-pdfjs-viewer>

Here is a use case to download and open the pdf as byte array and open in new tab/window:

Please note, pdfSrc can be a Blob or Uint8Array as well

For [externalWindow]="true" to work, pop-ups needs to be enabled at browser level


  

<!-- your.component.html -->

  

<button (click)="openPdf();">Open Pdf</button>

  

  

<div  style="width: 800px; height: 400px">

  

<ngx-pdfjs-viewer

  

#pdfViewerOnDemand

  

[externalWindow]="true"

  

[downloadFileName]="'mytestfile.pdf'"

  

[openFile]="false"

  

[viewBookmark]="false"

  

[download]="false"></ngx-pdfjs-viewer>

  

</div>

  

<div>

  

<div  style="width: 800px; height: 400px">

  

<ngx-pdfjs-viewer #pdfViewerAutoLoad></ngx-pdfjs-viewer>

  

</div>

  

<div  style="height: 600px">

  

<ngx-pdfjs-viewer  pdfSrc="gre_research_validity_data.pdf"  viewerId="MyUniqueID" (onBeforePrint)="testBeforePrint()" (onAfterPrint)="testAfterPrint()" (onDocumentLoad)="testPagesLoaded($event)" (onPageChange)="testPageChange($event)">

  

</ngx-pdfjs-viewer>

  

</div>

  



  

<!-- your.component.ts-->

  

import { Component, ViewChild } from  '@angular/core';

  

import { HttpClient } from  '@angular/common/http';

  

import { Observable } from  'rxjs';

  

import { map } from  'rxjs/operators';

  

...

  

  

export  class  MyComponent  implements  OnInit {

  

@ViewChild('pdfViewerOnDemand') pdfViewerOnDemand;

  

@ViewChild('pdfViewerAutoLoad') pdfViewerAutoLoad;

  

...

  

  

constructor(private  http: HttpClient) {

  

let  url = "api/document/getmypdf"; // Or your url

  

this.downloadFile(url).subscribe(

  

(res) => {

  

this.pdfViewerAutoLoad.pdfSrc = res; // pdfSrc can be Blob or Uint8Array

  

this.pdfViewerAutoLoad.refresh(); // Ask pdf viewer to load/refresh pdf

  

}

  

);

  

}

  

  

private  downloadFile(url: string): any {

  

return  this.http.get(url, { responseType:  'blob' })

  

.pipe(

  

map((result: any) => {

  

return  result;

  

})

  

);

  

}

  

  

public  openPdf() {

  

let  url = "url to fetch pdf as byte array"; // E.g. http://localhost:3000/api/GetMyPdf

  
  

  

this.downloadFile(url).subscribe(

  

(res) => {

  

this.pdfViewerOnDemand.pdfSrc = res; // pdfSrc can be Blob or Uint8Array

  

this.pdfViewerOnDemand.refresh(); // Ask pdf viewer to load/reresh pdf

  

}

  

);

  

}

License

MIT ©