So you've created a React component but would love to give end users the ability to print out the contents of that component. This package aims to solve that by popping up a new print window with CSS styles copied over as well.
npm install --save react-to-print
import React from 'react';
import ReactToPrint from 'react-to-print';
class ComponentToPrint extends React.Component {
render() {
return (
<table>
<thead>
<th>column 1</th>
<th>column 2</th>
<th>column 3</th>
</thead>
<tbody>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
</tbody>
</table>
);
}
}
class Example extends React.Component {
render() {
return (
<div>
<ReactToPrint
trigger={() => <a href="#">Print this out!</a>}
content={() => this.componentRef}
/>
<ComponentToPrint ref={el => (this.componentRef = el)} />
</div>
);
}
}Calling from functional components with hooks
import React, { useRef } from 'react';
import ReactToPrint from 'react-to-print';
class ComponentToPrint extends React.Component {
render() {
return (
<table>
<thead>
<th>column 1</th>
<th>column 2</th>
<th>column 3</th>
</thead>
<tbody>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
<tr>
<td>data 1</td>
<td>data 2</td>
<td>data 3</td>
</tr>
</tbody>
</table>
);
}
}
const Example = () => {
const componentRef = useRef();
return (
<div>
<ReactToPrint
trigger={() => <button>Print this out!</button>}
content={() => componentRef.current}
/>
<ComponentToPrint ref={componentRef} />
</div>
);
};NOTE: Node ^8.6 is required to build the library locally. We use Node ^10 for our CLI checks.
The component accepts the following props (note: ? denotes an optional prop):
| Name | Type | Description |
|---|---|---|
trigger |
function |
A function that returns a React Component or HTML element |
content |
function |
A function that returns a component reference value. The content of this reference value is then used for print |
copyStyles |
boolean? |
Copy all <style> and <link type="stylesheet" /> tags from <head> inside the parent window into the print window. (default: true) |
onBeforeGetContent |
function? |
Callback function that triggers before the library gathers the page's content. Either returns void or a Promise. This can be used to change the content on the page before printing. |
onBeforePrint |
function? |
Callback function that triggers before print. Either returns void or a Promise. Note: this function is run immediately prior to printing, but after the page's content has been gathered. To modify content before printing, use onBeforeGetContent instead. |
onAfterPrint |
function? |
Callback function that triggers after print |
onPrintError |
function(errorLocation: string, error: Error)? |
Callback function that will be called if there is a printing error serious enough that printing cannot continue. Currently limited to Promise rejections in onBeforeGetContent or onBeforePrint. Use this to attempt to print again. errorLocation will tell you in which callback the Promise was rejected. |
removeAfterPrint |
boolean? |
Remove the print iframe after action. Defaults to false. |
pageStyle |
string? |
Override default print window styling |
bodyClass |
string? |
Class to pass to the print window body |
suppressErrors |
boolean? |
When passed, prevents console logging of errors |
<link>s with empty href attributes are INVALID HTML. In addition, they can cause all sorts of undesirable behavior. For example, many browsers - including modern ones, when presented with <link href=""> will attempt to load the current page. Some even attempt to load the current page's parent directory.
Note: related to the above, img tags with empty src attributes are also invalid, and we do not attempt to load them.
If you've created a component that is intended only for printing and should not render in the parent component, wrap that component in a div with style set to { display: "none" }, like so:
<div style={{ display: "none" }}><ComponentToPrint ref={componentRef} /></div>This will hide ComponentToPrint but keep it in the DOM so that it can be copied for printing.