laurazenc / react-pdf-viewer

A React component to view a PDF document

React PDF viewer

A React component to view a PDF document. It's written in TypeScript, and powered by React hooks completely.

Features

Basic features

• Support password protected document
• Zooming: Support custom levels such as actual size, page fit, and page width
• Navigation between pages
• Can go to the first and last pages quickly
• Search for text
• Preview page thumbnails
• View and navigate the table of contents
• List and download attachments
• Rotating
• Text selection and hand tool modes
• Different scrolling modes
• Full screen mode
• Can open a file from local. Users can drag and drop a local file to view it
• Download file
• View the document properties
• Support SSR
• Print

Customization

• The toolbar can be customized easily
• All text items can be localized in another language

Coming soon

• Theming
• Darkmode

License

You have to purchase a Commercial License at the official website.

Usage

Perform the following steps to have the simplest example. For more demos, please look at the demo folder.

1. Install packages

$ npm install @phuocng/react-pdf-viewer
$ npm install pdfjs-dist

2. Import CSS and components

import Viewer, { Worker } from '@phuocng/react-pdf-viewer';

import '@phuocng/react-pdf-viewer/cjs/react-pdf-viewer.css';

3. Use the component

<Worker workerUrl="https://unpkg.com/pdfjs-dist@2.2.228/build/pdf.worker.min.js">
    <div style={{ height: '750px' }}>
        <Viewer fileUrl="/path/to/document.pdf" />
    </div>
</Worker>

Commands

1. Build:

$ npm run build

Then it will produce two formats available in the dist folder:

└─── dist
    ├─── cjs    // CommonJS package
    └─── umd    // UMD package

2. Dev mode:

$ npm run dev

The bundler will watch the entire src folder and build the cjs package when any source file is changed.

3. Lint:

$ npm run lint

It will check if the entire source code compatible with

• ESLint
• eslint-plugin-react
• typescript-eslint

About

This project is developed by Nguyen Huu Phuoc. You might be interesting in my projects:

Product	Description
Blur Page	A browser extension to hide sensitive information on a web page
CSS Layout	A collection of popular layouts and patterns made with CSS
Fake Numbers	Generate fake and valid numbers
Form Validation	The best validation library for JavaScript
HTML DOM	How to manage HTML DOM with vanilla JavaScript
React PDF Viewer	A React component to view a PDF document