{"_id":"@antoinepairet/ng2-pdfjs-viewer","_rev":"1-a579ffd872d746dc0996ab0b75e6ce1a","name":"@antoinepairet/ng2-pdfjs-viewer","dist-tags":{"latest":"0.2.29"},"versions":{"0.2.29":{"name":"@antoinepairet/ng2-pdfjs-viewer","version":"0.2.29","scripts":{"build":"gulp build","build:watch":"gulp","docs":"npm run docs:build","docs:build":"compodoc -p tsconfig.json -n ng2-pdfjs-viewer -d docs --hideGenerator","docs:serve":"npm run docs:build -- -s","docs:watch":"npm run docs:build -- -s -w","lint":"tslint --type-check --project tsconfig.json src/**/*.ts","lite":"lite-server","playground:build":"tsc -p playground -w","playground":"concurrently \"npm run build:watch\" \"npm run playground:build\" \"npm run lite\"","test":"tsc && karma start"},"repository":{"type":"git","url":"git+https://github.com/intbot/ng2-pdfjs-viewer.git"},"author":{"name":"Code1","email":"codehippie1@gmail.com"},"keywords":["angular","ng","ng2","pdfjs","viewerjs","viewer.html"],"license":"MIT","bugs":{"url":"https://github.com/intbot/ng2-pdfjs-viewer/issues"},"devDependencies":{"@angular-devkit/schematics":"^7.3.9","@angular/common":"^7.2.15","@angular/compiler":"^7.2.15","@angular/compiler-cli":"^7.2.15","@angular/core":"^7.2.15","@angular/platform-browser":"^7.2.15","@angular/platform-browser-dynamic":"^7.2.15","@compodoc/compodoc":"^1.0.9","@types/jasmine":"3.3.12","@types/karma":"^3.0.2","@types/node":"^12.0.2","angular-in-memory-web-api":"^0.8.0","codelyzer":"~5.0.1","concurrently":"^4.1.0","core-js":"^3.1.2","fs-extra":"^8.0.1","gulp":"^4.0.2","gulp-rename":"^1.2.2","gulp-rollup":"^2.16.2","jasmine-core":"~3.4.0","jasmine-spec-reporter":"~4.2.1","karma":"~4.1.0","karma-chrome-launcher":"~2.2.0","karma-cli":"~2.0.0","karma-coverage-istanbul-reporter":"^2.0.5","karma-jasmine":"~2.0.1","karma-jasmine-html-reporter":"^1.0.0","lite-server":"^2.3.0","node-sass":"^4.8.3","node-sass-tilde-importer":"^1.0.2","node-watch":"^0.6.2","protractor":"~5.4.2","rollup":"^1.12.3","run-sequence":"^2.2.1","rxjs":"^6.5.2","systemjs":"^3.1.6","ts-node":"~8.1.0","tslint":"~5.16.0","typescript":"^3.4.5","zone.js":"^0.9.1"},"engines":{"node":">=6.0.0"},"gitHead":"ce6432dfd3188d5eab3e831e5f39d8f933762372","description":"<p align=\"center\">   <a href=\"https://www.npmjs.com/package/ng2-pdfjs-viewer\">     <img src=\"https://img.shields.io/npm/dm/ng2-pdfjs-viewer.svg?style=flat\" alt=\"downloads\">   </a>   <a href=\"https://badge.fury.io/js/ng2-pdfjs-viewer\">     <img src=\"https:","homepage":"https://github.com/intbot/ng2-pdfjs-viewer#readme","_id":"@antoinepairet/ng2-pdfjs-viewer@0.2.29","_nodeVersion":"8.15.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-fqN3eQgzfyt/zzRrHq6L2MT0DXV6/sKvk3Qozd3qgEJe92Y6mW56tU7PLErBZ5JWJNa7PTFib3graq0Aijlvyw==","shasum":"cdbb448b9a8e1294f3905257379cd2f22fb951f1","tarball":"https://registry.npmjs.org/@antoinepairet/ng2-pdfjs-viewer/-/ng2-pdfjs-viewer-0.2.29.tgz","fileCount":1170,"unpackedSize":31182358,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc5RfBCRA9TVsSAnZWagAA+XsP/1fvdeMGiU2bah0e8ZRs\nhzclaytDiC4wXzRn1jwOlmYDJsLsqG77uLepWvnHXUSoH7M3Lkbt5pUJy4Jn\nrmyWsN3hhUC6B/52OA3GRE8yc47couGxJzJFEptaYuPnOhFzf/3D9FukHeyo\noPCivgVefIyqF/NUvNeLzK8xu9yfzqoUhD8E2ALyMHYc4UGkFFptl/BYxkxy\nWspbIIMRwEKzxtAajRfqLyihEadv6ANWoK4Uw7ruWw2/vBipjQk5G9zi/9lH\nhyIr8j8RjBgHLF6ykS7N6ZXAjsKVe6kuli6Ro9Q5P+cWJ1CNlfoJIFaquD4o\nvXmEyHX4UvLlnHNisL4XZu+kgsC4AVdhAms+DXlNkb77ysrSGiCyis8pNOWB\ndDrtsiZc2lYFvrUgpAFKymh+DvonU75Kq91BoYqXwxn9P67rXincdNfIhvUu\nIHQ5mgz2y6VGXyuU5/2JTsNCIBl4SXcDRi6Nu0DSSek4xnpRcUOYe9SfxsIN\nrkP2eGM8OC/wG8II5kMB638OKyN3YpX4X//Vm9nv+XEAbUNYvaiwL4Ah0B3U\nDtKRz+tH/N2xeF0WdJ060A9B+PNVC7JeWDVLsQmYdWJxfWjPGarb/3XVDyUv\nHeH2oLEdIOWgQ/qEIzXabwovuwBZlsqay7lyTjRuTdtTFqH+HByUYVUuxBiH\nG1z8\r\n=nu+v\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAXe4wDL+IttiLuprnkv21wx56mJmb2lq0CwdBbuhxJyAiA2EF40MJfK1iCDhy5Hg6rvlp9iu2bC1CZfykROlAjNCg=="}]},"maintainers":[{"name":"antoinepairet","email":"antoinepairet@gmail.com"}],"_npmUser":{"name":"antoinepairet","email":"antoinepairet@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ng2-pdfjs-viewer_0.2.29_1558517695635_0.9701246587520309"},"_hasShrinkwrap":false}},"time":{"created":"2019-05-22T09:34:55.635Z","0.2.29":"2019-05-22T09:34:57.047Z","modified":"2022-04-04T14:23:01.316Z"},"maintainers":[{"name":"antoinepairet","email":"antoinepairet@gmail.com"}],"description":"<p align=\"center\">   <a href=\"https://www.npmjs.com/package/ng2-pdfjs-viewer\">     <img src=\"https://img.shields.io/npm/dm/ng2-pdfjs-viewer.svg?style=flat\" alt=\"downloads\">   </a>   <a href=\"https://badge.fury.io/js/ng2-pdfjs-viewer\">     <img src=\"https:","homepage":"https://github.com/intbot/ng2-pdfjs-viewer#readme","keywords":["angular","ng","ng2","pdfjs","viewerjs","viewer.html"],"repository":{"type":"git","url":"git+https://github.com/intbot/ng2-pdfjs-viewer.git"},"author":{"name":"Code1","email":"codehippie1@gmail.com"},"bugs":{"url":"https://github.com/intbot/ng2-pdfjs-viewer/issues"},"license":"MIT","readme":"# Angular 2+ PDFJS viewer with Mozilla's ViewerJS\n<p align=\"center\">\n  <a href=\"https://www.npmjs.com/package/ng2-pdfjs-viewer\">\n    <img src=\"https://img.shields.io/npm/dm/ng2-pdfjs-viewer.svg?style=flat\" alt=\"downloads\">\n  </a>\n  <a href=\"https://badge.fury.io/js/ng2-pdfjs-viewer\">\n    <img src=\"https://badge.fury.io/js/ng2-pdfjs-viewer.svg\" alt=\"npm version\">\n  </a>\n</p>\n\nThis is a simple library wraps mozilla's pdfjs and viewerjs into an angular2+ component.\n\n### Open in a new tab/window\n<img src=\"/sampledoc/viewerImage.JPG\" alt=\"angular2+ pdfjs viewer in new window\"/>\n\n### Embed pdf into any angular component/page\n<img src=\"/sampledoc/viewerImageEmbedded2.jpg\" alt=\"angular2+ pdfjs viewer embedded\"/>\n\n## Installation\n\n## Step 1: To install `ng2-pdfjs-viewer`, run:\n\n```bash\n$ npm install ng2-pdfjs-viewer --save\n```\n\nAnd then configure it in your Angular `AppModule`:\n\n```typescript\nimport { BrowserModule } from '@angular/platform-browser';\nimport { NgModule } from '@angular/core';\n\nimport { AppComponent } from './app.component';\n\n// Import PdfJsViewerModule module\nimport { PdfJsViewerModule } from 'ng2-pdfjs-viewer';\n\n@NgModule({\n  declarations: [\n    AppComponent,\n  ],\n  imports: [\n    BrowserModule,\n    // Add to declarations\n    PdfJsViewerModule\n  ],\n  providers: [],\n  bootstrap: [AppComponent]\n})\nexport class AppModule { }\n```\n\n## Step 2: To use this library you need a copy of pdfjs\n1. Using modified version of viewerJs available in the package (Recommended approach)  \n    - Either copy `node_modules\\ng2-pdfjs-viewer\\pdfjs` to your public or asset folder Or use `TransferWebpackPlugin` or something similar to make sure the static files are accessible from the public folder in your application/webserver. Please note, if you decide to put `pdfjs` folder anywhere else other than the `assets` folder, make sure you also set `[pdfJsFolder]` property to help locate the folder.  \n\n    `TransferWebpackPlugin` Sample code  \n    ```typescript\n    var TransferWebpackPlugin = require('transfer-webpack-plugin');\n    ...\n    plugins: [\n      new TransferWebpackPlugin([\n        { from: 'node_modules\\ng2-pdfjs-viewer\\pdfjs', to: path.join(__dirname, 'assets') }\n      ])\n    ]\n    ```\n    Now you can use additional settings such as   \n     `[pdfJsFolder]`: To set the folder path under `web` and `build` resides.  \n     `[externalWindow]`: To decide pdf should be inline or in a new tab  \n     `[openFile]`: Show/hide open file icon  \n     `[viewBookmark]`: Show/hide bookmark icon  \n     `[download]`: Show/hide download icon  \n     `[showSpinner]`: Show a simple css based spinner/progress before the pdf loads  \n\nOR  \n\n2. Using pdf-js-gh-pages  \n    - Download pdfjs-gh-pages from here: https://github.com/mozilla/pdf.js/archive/gh-pages.zip and extract it.  \n    - Create a `pdfjs` folder under your angular2+ applications `assets` folder  \n    - Copy `pdf.js-gh-pages/build` and `pdf.js-gh-pages/web` folders from extracted package to `pdfjs` folder.  \n    - The web/ directory contains a 1 MB PDF file called \"compressed.tracemonkey-pldi-09.pdf\". This file is a sample and can safely  be removed.  \n    ps: More info can be found here: https://github.com/mozilla/pdf.js/wiki/setup-pdf.js-in-a-website\n\n## Usage    \n\n`For your convenience a sample app using angular6 is available under this repository, if you would like to see it in action (Folder ng6SampleApp). It shows many ways to configure this component for different needs.`\n\nOnce your PdfJsViewerComponent is imported  you can use it in your Angular application like this:\n\n```xml\n<!-- You can now use your library component in app.component.html -->\n<h1>\n  {{title}}\n</h1>\n<ng2-pdfjs-viewer pdfSrc=\"your pdf file path\"></ng2-pdfjs-viewer>\n```\n\nHere is a use case to download and open the pdf as byte array and open in new tab/window:\nPlease note, pdfSrc can be a Blob or Uint8Array as well\nFor [externalWindow]=\"true\" to work, pop-ups needs to be enabled at browser level\n\n```xml\n<!-- your.component.html -->\n<button (click)=\"openPdf();\">Open Pdf</button>\n\n<!-- Please note, you need a copy of https://github.com/intbot/ng2-pdfjs-viewer/tree/master/pdfjs for some of the below features to work -->\n<div style=\"width: 800px; height: 400px\">\n  <ng2-pdfjs-viewer \n    #pdfViewer\n    [pdfJsFolder]=\"'pdfjs'\"\n    [externalWindow]=\"true\"\n    [downloadFileName]=\"'mytestfile.pdf'\"\n    [openFile]=\"false\"\n    [viewBookmark]=\"false\"\n    [download]=\"false\"></ng2-pdfjs-viewer>\n</div>\n```\n\n```typescript\n<!-- your.component.ts-->\nexport class RateCardComponent implements OnInit {\n  @ViewChild('pdfViewer') pdfViewer\n  ...\n\n  private downloadFile(url: string): any {\n    return this.http.get(url, { responseType: ResponseContentType.Blob }).map(\n      (res) => {\n        return new Blob([res.blob()], { type: \"application/pdf\" });\n      });\n  }\n\n  public openPdf() {\n    let url = \"url to fetch pdf as byte array\";\n    // url can be local url or remote http request to an api/pdf file. \n    // E.g: let url = \"assets/pdf-sample.pdf\";\n    // E.g: https://github.com/intbot/ng2-pdfjs-viewer/tree/master/sampledoc/pdf-sample.pdf\n    // E.g: http://localhost:3000/api/GetMyPdf\n    // Please note, for remote urls to work, CORS should be enabled at the server. Read: https://enable-cors.org/server.html\n\n    this.downloadFile(url).subscribe(\n\n(res) => {\n        this.pdfViewer.pdfSrc = res; // pdfSrc can be Blob or Uint8Array\n        this.pdfViewer.refresh(); // Ask pdf viewer to load/reresh pdf\n      }\n    );\n  }\n```\n\n# Additional Information\nGiven below are examples of writing server apis(In aspnetcore c#) which returns pdfs as byte array. You can choose any server side technology as long as pdf is returned as byte array\n\nUse case 1. As a RDLC local report viewer\n```c#\n[HttpGet]\n[Route(\"MyReport\")]\npublic IActionResult GetReport()\n{\n   // var reportObjectList1\n   // var reportObjectList2\n   var reportViewer = new ReportViewer {ProcessingMode = ProcessingMode.Local};\n   reportViewer.LocalReport.ReportPath = \"Reports/MyReport.rdlc\";\n\n   reportViewer.LocalReport.DataSources.Add(new ReportDataSource(\"NameOfDataSource1\", reportObjectList1));\n   reportViewer.LocalReport.DataSources.Add(new ReportDataSource(\"NameOfDataSource2\", reportObjectList1));\n\n   Warning[] warnings;\n   string[] streamids;\n   string mimeType;\n   string encoding;\n   string extension;\n\n   var bytes = reportViewer.LocalReport.Render(\"application/pdf\", null, out mimeType, out encoding, out extension, out streamids, out warnings);\n\n   // The below content-disposition is lost when we create Blob() object in client browser. Hence commented out\n   //var cd = new System.Net.Mime.ContentDisposition\n   //{\n   //    FileName = \"somepdf.pdf\",\n   //    Inline = true\n   //};\n   //Response.Headers.Add(\"Content-Disposition\", cd.ToString());\n   \n   return File(bytes, \"application/pdf\")\n}\n```\n\nUse case 2. Return a physical pdf from server\n```c#\n[HttpGet]\n[Route(\"GetMyPdf\")]\npublic IActionResult GetMyPdf()\n{\n   var stream = await {{__get_stream_here__}}\n   return File(stream, \"application/pdf\")); // FileStreamResult\n   \n  // OR\n  // var bytes = await {{__get_bytes_here__}}\n  // return File(bytes, \"application/pdf\")\n}\n```\n\n## Questions?\nThere are several how to questions being posted in issues section of this repository. Questions would be better answered if posted on  www.stackoverflow.com with tag <b>ng2-pdfjs-viewer</b> (Please create this tag if not already present)\n\n## Other projects worth mentioning\n1. Angular 5+ [ng2-pdf-viewer](https://github.com/VadimDez/ng2-pdf-viewer)\n2. AngularJS [angular-pdfjs-viewer](https://github.com/legalthings/angular-pdfjs-viewer)\n3. Angular [ngx-extended-pdf-viewer](https://github.com/stephanrauh/ngx-extended-pdf-viewer)\n\n## License\n\nMIT © [Code Hippie](mailto:codehippie1@gmail.com)\n","readmeFilename":"README.MD"}