angular-pdf

Version: 2.1.3

An AngularJS directive ng-pdf to display PDF files with PDFJS.

Overview [demo]

Integrate PDF files right into web pages.

Requirements

Check bower.json file for dependencies and their versions:

AngularJS - get the latest angular.min.js

PDFJS - build the files pdf.js and pdf.worker.js
Waypoints - get the latest waypoints bower package and include noframework.waypoints.min.js in your project.
Evergreen browsers

Features

zoom in / out / fit 100%

rotate clockwise
continous scrolling through pages
confine rendering to container
define the view template
define the path to pdf with scope variable
handles error
show loading of pdf
show progress percentage of loading pdf
dynamically change the pdf url
support retina canvas

Getting Started

install or copy over the file dist/angular-pdf.min.js or dist/angular-pdf.js
```
bower install angular-pdf
```

include the path to the direcitve file in index.html

<script src="js/vendor/angular-pdf/dist/angular-pdf.js"></script>

include the directive as a dependency when defining the angular app:
```
var app = angular.module('App', ['pdf']);
```

include the directive with the attribute path to the partial under a controller

<div class="wrapper" ng-controller="DocCtrl">
    <ng-pdf template-url="/partials/viewer.html"></ng-pdf>
</div>

scale as an option

<ng-pdf template-url="/partials/viewer.html" scale=1></ng-pdf>

scale attribute can also be page-fit

<ng-pdf template-url="/partials/viewer.html" scale="page-fit"></ng-pdf>

containerid as an option for id of the canvas container (default for containerid is pdf-container)
```
<ng-pdf template-url="/partials/viewer.html" containerid="mycanvas"></ng-pdf>
```

usecredentials as an option to add credentials / authorisation

<ng-pdf template-url="/partials/viewer.html" usecredentials="true"></ng-pdf>

debug to enable debugging console output (optional, disabled by default)
```
<ng-pdf template-url="/partials/viewer.html" debug="true"></ng-pdf>
```

include the container element to display the pdf in the template-url file
```
<div id="pdf-container">
     <canvas ng-repeat="id in pageIDs" ng-attr-id="{{id}}"></canvas>
</div>
```
you have to use the pageIDs to find the list of IDs for each page and set the attribute id accordingly. The canvas element can be styled as you with.

include the path to the pdf file in the controller

app.controller('DocCtrl', function($scope) {
    $scope.pdfUrl = '/pdf/relativity.pdf';
});

or provide a value for pdfData field of the parent.

Options

Zoom in / out / fit 100%: Include the controls in the view file as defined in the attribute template-url

<button ng-click="zoomIn()">+</span></button>
<button ng-click="fit()">100%</span></button>
<button ng-click="zoomOut()">-</span></button>

Rotate clockwise: Include the controls in the view file as defined in the attribute template-url and the initial class rotate0

<button ng-click="rotate()">90</span></button>
...
<canvas id="pdf-canvas" class="rotate0"></canvas>

include the css styles:

.rotate0 {-webkit-transform: rotate(0deg); transform: rotate(0deg); }
.rotate90 {-webkit-transform: rotate(90deg); transform: rotate(90deg); }
.rotate180 {-webkit-transform: rotate(180deg); transform: rotate(180deg); }
.rotate270 {-webkit-transform: rotate(270deg); transform: rotate(270deg); }

Confine the rendering within fixed size container: When the canvas elements are included in a fixed size controller, the waypoints need to be given the parent context. Add the option context="containerID" to ng-pdf directive to indicate this. This way, the current page is corectly updated on scroll.

Fixed pdf controls upon scrolling: Wrap the controls in the view file as defined in the attribute template-url with a tag nav with an ng-class. Amend the scroll amount as required.

<nav ng-class="{'pdf-controls fixed': scroll > 100, 'pdf-controls': scroll <= 100}">
...
</nav>

And include the relevant css styles as required:

.pdf-controls { width: 100%; display: block; background: #eee; padding: 1em;}
.fixed { position: fixed; top: 0; left: calc(50% - 480px); z-index: 100; width: 100%; padding: 1em; background: rgba(238, 238, 238,.9); width: 960px; }

open the file index.html with a web server

When url is base64 or Uint8Array

Create a Blob:

currentBlob = new Blob([result], {type: 'application/pdf'});
$scope.pdfUrl = URL.createObjectURL(currentBlob);

or set attribute pdfData.

Handle error

In the controller, you can call the function $scope.onError:

$scope.onError = function(error) {
	// handle the error
	// console.log(error);
}

Display current page number

angularjs-pdf uses waypoints to determine on what page the current view is. Display variable pageNum to inform the user or the postition. pageNum is automatically updated upon scrolling.

Show loading

In the controller, you can call the function $scope.onLoad when the pdf succesfully loaded:

$scope.loading = 'loading';

$scope.onLoad = function() {
  // do something when pdf is fully loaded
  // $scope.loading = '';
}

Show progress percentage

In the controller, you can call the function $scope.onProgress

$scope.onProgress = function(progress) {
	// handle a progress bar
  	// progress% = progress.loaded / progress.total
  	// console.log(progress);
}

Variations

If using with Angular UI modal, pageNum attribute is no longer required. Checkout the implementation

Similar projects

angular-pdf-viewer - a more self-contained directive

ng-pdfviewer

Credit

PDF example used is Relativity: The Special and General Theory by Albert Einstein as kindly organized and made available free by Project Gutenberg.

Contribute

This project is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Please see CONTRIBUTING.md for details.

Versioning

This repository follows the Semantic Versioning guidelines:

For patches, run the command:
```
grunt bump
```

For minor release, run the command:
```
 grunt bump:minor
```
For major release, run the command:
```
 grunt bump:major
```

alinVD / angularjs-pdf