react-to-pdf

React to PDF

Easily create PDF documents from React components.

Install

$ npm install react-to-pdf

Important Notes

• Not vectorized - the pdf is created from a screenshot of the component and therefore is not vectorized. If you are looking for something more advanced to generate pdf using React components, please check out other popular alternatives packages listed below.
• No SSR

Alternatives and Similars Packages

• @react-pdf/renderer - React renderer to create PDF files on the browser and server
• react-pdf - Display PDFs in your React app as easily as if they were images.

Usage

Using hook

import { usePDF } from 'react-to-pdf';

const Component = () => {
   const { toPDF, targetRef } = usePDF({filename: 'page.pdf'});
   return (
      <button onClick={toPDF}>Download PDF</button>
      <div ref={targetRef}>
         Content to be generated to PDF
      </div>
   )
}

Using default function

import { useRef } from 'react';
import generatePDF from 'react-to-pdf';

const Component = () => {
   const targetRef = useRef();
   return (
      <button onClick={() => generatePDF(targetRef, {filename: 'page.pdf'})}>Download PDF</button>
      <div ref={targetRef}>
         Content to be included in the PDF
      </div>
   )
}

Advanced options

import generatePDF, { Resolution, Margin } from 'react-to-pdf';

const options = {
   // default is `save`
   method: 'open',
   // default is Resolution.MEDIUM = 3, which should be enough, higher values
   // increases the image quality but also the size of the PDF, so be careful
   // using values higher than 10 when having multiple pages generated, it
   // might cause the page to crash or hang.
   resolution: Resolution.HIGH,
   page: {
      // margin is in MM, default is Margin.NONE = 0
      margin: Margin.SMALL,
      // default is 'A4'
      format: 'letter',
      // default is 'portrait'
      orientation: 'landscape',
   },
   canvas: {
      // default is 'image/jpeg' for better size performance
      mimeType: 'image/png'
      qualityRatio: 1
   },
   // customize any value passed to the jsPDF instance and html2canvas
   // function
   overrides: {
      // see https://artskydj.github.io/jsPDF/docs/jsPDF.html for more options
      pdf: {
         compress: true
      },
      // see https://html2canvas.hertzen.com/configuration for more options
      canvas: {
         useCORS: false
      }
   },
};

const Component = () => {
   // you can use a function to return the target element besides using React refs
   const getTargetElement = () => document.getElementById('content-id');
   return (
      <button onClick={() => generatePDF(getTargetElement, options)}>Generate PDF</button>
      <div id="content-id">
         Content to be generated to PDF
      </div>
   );
}

Changelog

1.0.0-alpha.0 (August 26, 2023)

New Features

• React 18 support
• Multipage support
• Typescript
• Supports opening the PDF in the browser via the method open. The build method can be used to just return the built PDF.
• Possible to set the quality of the image using the resolution option.
• Margin is now easier to set using the margin option, either by setting values especifically for each point (top, bottom, left, right) or a general value for all points.
• Possible to override or customize values also passed for the `html2canvas`` function.

Breaking Changes

• The wrapper react component no longer exists. Use either the default function or the usePDF hook. See below an example on how to migrate from the v0 to v1;
• The following props were not included in the 1.x available options:
  • scale - not supported, if you want to get a higher PDF resolution, use the resolution option instead
  • x - Use margin param instead
  • y - Use margin param instead
  • onComplete - The default function and the toPDF function returned in the usePDF hook returns a Promise that can be awaited instead of the onComplete callback

Migrating from v0 to v1:

Before (v0):

import ReactToPdf from 'react-to-pdf'
const Component = () => (
    const handleComplete = () => {
        console.log('PDF has been generated')
    }
    return (
        <ReactToPdf filename="page.pdf" options={{compress: true}} x={5} y={5} onComplete={handleComplete}>
            {({toPdf, targetRef}) =>  (
                <div>
                    <button onClick={toPdf}>Generate PDF</button>
                    <div ref={targetRef}>
                        Content to be included in the PDF
                    </div>
                </div>
            )}
        </ReactToPdf>
    )
)

After (v1):

import { usePDF }  from 'react-to-pdf'

const Component = () => (
    const { toPDF, targetRef } = usePDF();
    const options = {
        filename: 'page.pdf',
        page: {
            margin: 5
        },
        overrides: {
            pdf: {
                compress: true
            }
        }
    }
    const handleGeneratePDF = async () => {
        await toPDF(options);
        console.log('PDF has been generated')
    }
    return (
        <div>
            <button onClick={handleGeneratePDF}>Generate PDF</button>
            <div ref={targetRef}>
                Content to be included in the PDF
            </div>
        </div>
    )
)