React-PDF

Display PDFs in your React app as easily as if they were images.

Lost?

This package is used to display existing PDFs. If you wish to create PDFs using React, you may be looking for @@omegion1npm/eius-blanditiis-quis/renderer.

tl;dr

• Install by executing npm install @omegion1npm/eius-blanditiis-quis or yarn add @omegion1npm/eius-blanditiis-quis.
• Import by adding import { Document } from '@omegion1npm/eius-blanditiis-quis'.
• Use by adding <Document file="..." />. file can be a URL, base64 content, Uint8Array, and more.
• Put <Page /> components inside <Document /> to render pages.

Demo

A minimal demo page can be found in sample directory.

Online demo is also available!

Before you continue

React-PDF is under constant development. This documentation is written for React-PDF 7.x branch. If you want to see documentation for other versions of React-PDF, use dropdown on top of GitHub page to switch to an appropriate tag. Here are quick links to the newest docs from each branch:

• v6.x
• v5.x
• v4.x
• v3.x
• v2.x
• v1.x

Getting started

Compatibility

Browser support

React-PDF supports all modern browsers. It is tested with the latest versions of Chrome, Edge, Safari, Firefox, and Opera.

The following browsers are supported out of the box in React-PDF v7:

• Chrome ≥92
• Edge ≥92
• Safari ≥15.4
• Firefox ≥90

You may extend the list of supported browsers by providing additional polyfills (e.g. for Array.prototype.at or Promise.allSettled) and either configuring your bundler to transpile pdfjs-dist and using legacy PDF.js worker.

If you need to support older browsers, you will need to use React-PDF v6 or v5.

If you need to support Internet Explorer 11, you will need to use React-PDF v4.

React

To use the latest version of React-PDF, your project needs to use React 16.8 or later.

If you use an older version of React, please refer to the table below to a find suitable React-PDF version.

Preact

React-PDF may be used with Preact.

Installation

Add React-PDF to your project by executing npm install @omegion1npm/eius-blanditiis-quis or yarn add @omegion1npm/eius-blanditiis-quis.

Next.js

If you use Next.js, you may need to add the following to your next.config.js:

1module.exports = {
2+ webpack: (config) => {
3+   config.resolve.alias.canvas = false;
4
5+   return config;
6+ },
7}

Configure PDF.js worker

For React-PDF to work, PDF.js worker needs to be provided. You have several options.

Import worker (recommended)

For most cases, the following example will work:

1import { pdfjs } from '@omegion1npm/eius-blanditiis-quis';
2
3pdfjs.GlobalWorkerOptions.workerSrc = new URL(
4  'pdfjs-dist/build/pdf.worker.min.js',
5  import.meta.url,
6).toString();

Note In Next.js:

• Using App Router, make sure to add 'use client'; to the top of the file.
• Using Pages Router, make sure to disable SSR when importing the component you're using this code in.

Note pnpm requires an .npmrc file with public-hoist-pattern[]=pdfjs-dist for this to work.

1 pdfjs.GlobalWorkerOptions.workerSrc = new URL(
2-  'pdfjs-dist/build/pdf.worker.min.js',
3+  'npm:pdfjs-dist/build/pdf.worker.min.js',
4   import.meta.url,
5 ).toString();

Copy worker to public directory

You will have to make sure on your own that pdf.worker.js file from pdfjs-dist/build is copied to your project's output folder.

For example, you could use a custom script like:

1import path from 'node:path';
2import fs from 'node:fs';
3
4const pdfjsDistPath = path.dirname(require.resolve('pdfjs-dist/package.json'));
5const pdfWorkerPath = path.join(pdfjsDistPath, 'build', 'pdf.worker.js');
6
7fs.copyFileSync(pdfWorkerPath, './dist/pdf.worker.js');

Use external CDN

1import { pdfjs } from '@omegion1npm/eius-blanditiis-quis';
2
3pdfjs.GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${pdfjs.version}/build/pdf.worker.min.js`;

Legacy PDF.js worker

If you need to support older browsers, you may use legacy PDF.js worker. To do so, follow the instructions above, but replace /build/ with legacy/build/ in PDF.js worker import path, for example:

1 pdfjs.GlobalWorkerOptions.workerSrc = new URL(
2-  'pdfjs-dist/build/pdf.worker.min.js',
3+  'pdfjs-dist/legacy/build/pdf.worker.min.js',
4   import.meta.url,
5 ).toString();

or:

1-pdfjs.GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${pdfjs.version}/build/pdf.worker.min.js`;
2+pdfjs.GlobalWorkerOptions.workerSrc = `//unpkg.com/pdfjs-dist@${pdfjs.version}/legacy/build/pdf.worker.min.js`;

Usage

Here's an example of basic usage:

1import { useState } from 'react';
2import { Document, Page } from '@omegion1npm/eius-blanditiis-quis';
3
4function MyApp() {
5  const [numPages, setNumPages] = useState<number>();
6  const [pageNumber, setPageNumber] = useState<number>(1);
7
8  function onDocumentLoadSuccess({ numPages }: { numPages: number }): void {
9    setNumPages(numPages);
10  }
11
12  return (
13    <div>
14      <Document file="somefile.pdf" onLoadSuccess={onDocumentLoadSuccess}>
15        <Page pageNumber={pageNumber} />
16      </Document>
17      <p>
18        Page {pageNumber} of {numPages}
19      </p>
20    </div>
21  );
22}

Check the sample directory in this repository for a full working example. For more examples and more advanced use cases, check Recipes in React-PDF Wiki.

Support for annotations

If you want to use annotations (e.g. links) in PDFs rendered by React-PDF, then you would need to include stylesheet necessary for annotations to be correctly displayed like so:

1import '@omegion1npm/eius-blanditiis-quis/dist/Page/AnnotationLayer.css';

Support for text layer

If you want to use text layer in PDFs rendered by React-PDF, then you would need to include stylesheet necessary for text layer to be correctly displayed like so:

1import '@omegion1npm/eius-blanditiis-quis/dist/Page/TextLayer.css';

Support for non-latin characters

If you want to ensure that PDFs with non-latin characters will render perfectly, or you have encountered the following warning:

Warning: The CMap "baseUrl" parameter must be specified, ensure that the "cMapUrl" and "cMapPacked" API parameters are provided.

then you would also need to include cMaps in your build and tell React-PDF where they are.

Copying cMaps

First, you need to copy cMaps from pdfjs-dist (React-PDF's dependency - it should be in your node_modules if you have React-PDF installed). cMaps are located in pdfjs-dist/cmaps.

Vite

Add vite-plugin-static-copy by executing npm install vite-plugin-static-copy --save-dev or yarn add vite-plugin-static-copy --dev and add the following to your Vite config:

1+import path from 'node:path';
2+import { createRequire } from 'node:module';
3
4-import { defineConfig } from 'vite';
5+import { defineConfig, normalizePath } from 'vite';
6+import { viteStaticCopy } from 'vite-plugin-static-copy';
7
8+const require = createRequire(import.meta.url);
9+const cMapsDir = normalizePath(
10+  path.join(path.dirname(require.resolve('pdfjs-dist/package.json')), 'cmaps')
11+);
12
13export default defineConfig({
14  plugins: [
15+   viteStaticCopy({
16+     targets: [
17+       {
18+         src: cMapsDir,
19+         dest: '',
20+       },
21+     ],
22+   }),
23  ]
24});

Webpack

Add copy-webpack-plugin by executing npm install copy-webpack-plugin --save-dev or yarn add copy-webpack-plugin --dev and add the following to your Webpack config:

1+import path from 'node:path';
2+import CopyWebpackPlugin from 'copy-webpack-plugin';
3
4+const cMapsDir = path.join(path.dirname(require.resolve('pdfjs-dist/package.json')), 'cmaps');
5
6module.exports = {
7  plugins: [
8+   new CopyWebpackPlugin({
9+     patterns: [
10+       {
11+         from: cMapsDir,
12+         to: 'cmaps/'
13+       },
14+     ],
15+   }),
16  ],
17};

Other tools

If you use other bundlers, you will have to make sure on your own that cMaps are copied to your project's output folder.

For example, you could use a custom script like:

1import path from 'node:path';
2import fs from 'node:fs';
3
4const cMapsDir = path.join(path.dirname(require.resolve('pdfjs-dist/package.json')), 'cmaps');
5
6fs.cpSync(cMapsDir, 'dist/cmaps/', { recursive: true });

Setting up React-PDF

Now that you have cMaps in your build, pass required options to Document component by using options prop, like so:

1// Outside of React component
2const options = {
3  cMapUrl: '/cmaps/',
4};
5
6// Inside of React component
7<Document options={options} />;

Note Make sure to define options object outside of your React component, and use useMemo if you can't.

Alternatively, you could use cMaps from external CDN:

1// Outside of React component
2import { pdfjs } from '@omegion1npm/eius-blanditiis-quis';
3
4const options = {
5  cMapUrl: `https://unpkg.com/pdfjs-dist@${pdfjs.version}/cmaps/`,
6};
7
8// Inside of React component
9<Document options={options} />;

Support for standard fonts

If you want to support PDFs using standard fonts (deprecated in PDF 1.5, but still around), ot you have encountered the following warning:

The standard font "baseUrl" parameter must be specified, ensure that the "standardFontDataUrl" API parameter is provided.

then you would also need to include standard fonts in your build and tell React-PDF where they are.

Copying fonts

First, you need to copy standard fonts from pdfjs-dist (React-PDF's dependency - it should be in your node_modules if you have React-PDF installed). Standard fonts are located in pdfjs-dist/standard_fonts.

Vite

Add vite-plugin-static-copy by executing npm install vite-plugin-static-copy --save-dev or yarn add vite-plugin-static-copy --dev and add the following to your Vite config:

1+import path from 'node:path';
2+import { createRequire } from 'node:module';
3
4-import { defineConfig } from 'vite';
5+import { defineConfig, normalizePath } from 'vite';
6+import { viteStaticCopy } from 'vite-plugin-static-copy';
7
8+const require = createRequire(import.meta.url);
9+const standardFontsDir = normalizePath(
10+  path.join(path.dirname(require.resolve('pdfjs-dist/package.json')), 'standard_fonts')
11+);
12
13export default defineConfig({
14  plugins: [
15+   viteStaticCopy({
16+     targets: [
17+       {
18+         src: standardFontsDir,
19+         dest: '',
20+       },
21+     ],
22+   }),
23  ]
24});

Webpack

Add copy-webpack-plugin by executing npm install copy-webpack-plugin --save-dev or yarn add copy-webpack-plugin --dev and add the following to your Webpack config:

1+import path from 'node:path';
2+import CopyWebpackPlugin from 'copy-webpack-plugin';
3
4+const standardFontsDir = path.join(path.dirname(require.resolve('pdfjs-dist/package.json')), 'standard_fonts');
5
6module.exports = {
7  plugins: [
8+   new CopyWebpackPlugin({
9+     patterns: [
10+       {
11+         from: standardFontsDir,
12+         to: 'standard_fonts/'
13+       },
14+     ],
15+   }),
16  ],
17};

Other tools

If you use other bundlers, you will have to make sure on your own that standard fonts are copied to your project's output folder.

For example, you could use a custom script like:

1import path from 'node:path';
2import fs from 'node:fs';
3
4const standardFontsDir = path.join(
5  path.dirname(require.resolve('pdfjs-dist/package.json')),
6  'standard_fonts',
7);
8
9fs.cpSync(standardFontsDir, 'dist/standard_fonts/', { recursive: true });

Setting up React-PDF

Now that you have standard fonts in your build, pass required options to Document component by using options prop, like so:

1// Outside of React component
2const options = {
3  standardFontDataUrl: '/standard_fonts/',
4};
5
6// Inside of React component
7<Document options={options} />;

Note Make sure to define options object outside of your React component, and use useMemo if you can't.

Alternatively, you could use standard fonts from external CDN:

1// Outside of React component
2import { pdfjs } from '@omegion1npm/eius-blanditiis-quis';
3
4const options = {
5  standardFontDataUrl: `https://unpkg.com/pdfjs-dist@${pdfjs.version}/standard_fonts`,
6};
7
8// Inside of React component
9<Document options={options} />;

User guide

Document

Loads a document passed using file prop.

Props

Page

Displays a page. Should be placed inside <Document />. Alternatively, it can have pdf prop passed, which can be obtained from <Document />'s onLoadSuccess callback function, however some advanced functions like rendering annotations and linking between pages inside a document may not be working correctly.

Props

Outline

Displays an outline (table of contents). Should be placed inside <Document />. Alternatively, it can have pdf prop passed, which can be obtained from <Document />'s onLoadSuccess callback function.

Props

Thumbnail

Displays a thumbnail of a page. Does not render the annotation layer or the text layer. Does not register itself as a link target, so the user will not be scrolled to a Thumbnail component when clicked on an internal link (e.g. in Table of Contents). When clicked, attempts to navigate to the page clicked (similarly to a link in Outline). Should be placed inside <Document />. Alternatively, it can have pdf prop passed, which can be obtained from <Document />'s onLoadSuccess callback function.

Props

Props are the same as in <Page /> component, but certain annotation layer and text layer-related props are not available:

• customTextRenderer
• onGetAnnotationsError
• onGetAnnotationsSuccess
• onGetTextError
• onGetTextSuccess
• onRenderAnnotationLayerError
• onRenderAnnotationLayerSuccess
• onRenderTextLayerError
• onRenderTextLayerSuccess
• renderAnnotationLayer
• renderForms
• renderTextLayer

On top of that, additional props are available:

Useful links

• React-PDF Wiki

License

The MIT License.

Author