ngx-print
Version:
Plug n' Play Angular (2++) directive to print your stuff
279 lines (189 loc) • 7.79 kB
Markdown
[](https://www.npmjs.com/package/ngx-print) [](https://travis-ci.org/selemxmn/ngx-print) [](https://coveralls.io/github/selemxmn/ngx-print?branch=unit-tests)
# ngx-print : *plug n' play Angular (2++) directive to print your stuff*
This directive makes printing your HTML sections smooth and easy in your Angular application. It is inspired from the old [AngularJS ngPrint](https://github.com/gilf/ngPrint) directive, thus it is intendend to be used with the new Angular -2/4/5/6/7-... ***Enjoy ! contributions are so welcomed :)***
## Dependencies
| ngx-print | Angular |
| ------------ | ------------ |
| 1.2.1 | 7.0.0 - 14.1.0 |
| 1.3.x | 15.0.0 |
| 1.4.x | 16.0.0 |
| 1.5.x | 17.0.0 |
| 2.x.x | 18.0.0 |
| 3.x.x | 19.0.0 |
| 20.x.x | 20.0.0 |
## Version Alignment Notice
Starting with version 20.0.0, this package aligns its major version with the Angular framework version for better clarity and compatibility tracking. Version 20 is intended for Angular 20 and so on.
## Setup
**1-** In your root application folder run:
```bash
$ npm install ngx-print
```
**2-** Once `ngx-print` is installed, you need to import the main module `NgxPrintModule` :
```js
import {NgxPrintModule} from 'ngx-print';
@NgModule({
...
imports: [NgxPrintModule, ...],
...
})
export class YourAppModule {
}
```
**3-** Then plug n' play with it:
- Assuming you want to print the following HTML section:
```html
<div>
<!--Your html stuff that you want to print-->
</div>
<button>print</button> <!--Your relevant print button-->
```
- Now, what you have to do is tagging your *wanted-to-print* section by an `id` attribute, then link that `id` to a directive parameter in your button :
```html
<!--
1)- Add an ID here
-->
<div id="print-section">
<!--Your html stuff that you want to print-->
</div>
<!--
2)- Add the directive name in your button (ngxPrint),
3)- Affect your ID to printSectionId
-->
<button printSectionId="print-section" ngxPrint>print</button>
```
## Optional properties
- You want a customized title for your printing window ? you have the choice by adding a new attribute to your print button `printTitle`:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
printTitle="MyTitle"
printSectionId="print-section"
ngxPrint>print</button>
```
- Also, would you like to customize the printing window style sheet (CSS) ? Hence you can do so by adding infinite styles to another attribute called `printStyle`:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
[printStyle]="{h1 : {'color': 'red'}, h2 : {'border': 'solid 1px'}}"
printSectionId="print-section"
ngxPrint>print</button>
```
Here some simple styles were added to every `h1` & `h2` tags within the `div` where `print-section` is tagged to its `id` attribute.
- If you would like to use your existing CSS with media print you can add the `useExistingCss` attribute:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
[useExistingCss]="true"
printSectionId="print-section"
ngxPrint>print</button>
```
- If you want to customize the printing window style sheet (CSS) by importing the css provided in assets/css use `styleSheetFile`:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
styleSheetFile="assets/css/custom1.css,assets/css/custom2.css"
printSectionId="print-section"
ngxPrint>print</button>
```
- If you would like to show a preview without a print dialog use
`previewOnly`:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
[previewOnly]="true"
printSectionId="print-section"
ngxPrint>print</button>
```
- Some print operations open a second dialog, and automatically closing the popup window happens before the second dialog opens. Set `closeWindow` to false to handle print operations that open a second dialog, like "Microsoft Print to PDF", or "Print using system dialog...":
```html
<div id="print-section">
<!-- ... -->
</div>
<button
[closeWindow]="false"
printSectionId="print-section"
ngxPrint>print</button>
```
- Set `bodyClass` to whatever class values are needed for some of your css rules that expect an ancestor to have a certain class. For example, a theme selector:
```html
<div id="print-section">
<!-- ... -->
</div>
<button
[bodyClass]="theme-dark"
printSectionId="print-section"
ngxPrint>print</button>
```
- To print in a new tab rather than a new window set the property `openNewTab` to true. By default `openNewTab` is false and ngxPrint will open a new print window.
```html
<button
[openNewTab]="true"
ngxPrint>print</button>
```
- To run a function after printing completes, subscribe to the `printCompleted` event. Please note it is impossible to differentiate between the Cancel or Print buttong being clicked on the print window. This event will fire regardless of which button was clicked:
```html
<button
(printCompleted)="onPrintComplete()"
printSectionId="print-section"
ngxPrint>
print
</button>
```
## Using NgxPrint as a service (v1.5+)
Inject the NgxPrintService in the constructor of your component or service:
```typescript
constructor(private printService: NgxPrintService) { }
```
### Printing a Section
```typescript
import { PrintOptions } from './path-to-your/print-options.model';
printMe() {
const customPrintOptions: PrintOptions = new PrintOptions({
printSectionId: 'print-section',
// Add any other print options as needed
});
this.printService.print(customPrintOptions)
}
```
### Print Options Object
The print options object allows you to specify how the print job should be handled. All of which have default values that you can optionally override, although printSectionId is required. It contains the following properties:
```typescript
printSectionId: string = null;
printTitle: string = null;
useExistingCss: boolean = false;
bodyClass: string = '';
openNewTab: boolean = false;
previewOnly: boolean = false;
closeWindow: boolean = true;
printDelay: number = 0;
```
### Setting PrintStyles or StyleSheets
```typescript
// Optional property for css as a key-value pair
this.printService.printStyle = styleSheet;
// Optional property for a css file location
this.printService.styleSheetFile = fileLocation;
```
### Subscribing to print event
```typescript
this.printService.printComplete$.pipe(take(1)).subscribe(() => {
console.log('Print completed!');
});
```
## Content-Security-Policy (CSP) Support
If Angular is configured to use a [CSP Nonce](https://angular.io/api/core/CSP_NONCE), ngx-print will automatically inject the `[printStyle]` CSS rules with this Nonce authorization.
## Contributors :1st_place_medal:
Huge thanks to: [deeplotia](https://github.com/deeplotia) , [Ben L](https://github.com/broem) , [Gavyn McKenzie](https://github.com/gavmck) , [silenceway](https://github.com/silenceway), [Muhammad Ahsan Ayaz](https://github.com/AhsanAyaz), [Core121](https://github.com/Core121) and to all `ngx-print` users
## Donation
Did this project help you reducing time? I won't say no to a cup of coffee 🍵 :)
[](https://www.paypal.me/selemxmn/2)