# react-pdf-reader

> [![npm version](https://badge.fury.io/js/react-pdf-reader.svg)](https://badge.fury.io/js/react-pdf-reader) ![Travis build](https://travis-ci.org/kemy971/react-pdf-reader.svg?branch=feature%2Ftravisci) [![CircleCI](https://circleci.com/gh/kemy971/react-pdf

Latest version **0.1.8** (published 2017-10-24) · 0 weekly downloads

## Install

```sh
npm install react-pdf-reader
pnpm add react-pdf-reader
yarn add react-pdf-reader
bun add react-pdf-reader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2017-10-24 |
| First published | 2017-07-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Kémy CASSIN |
| Maintainers | lekem |
| Keywords | ReactJS, PDFJS, PDF |

## Links

- npm: https://www.npmjs.com/package/react-pdf-reader
- Repository: https://github.com/kemy971/react-pdf-reader
- Homepage: https://github.com/kemy971/react-pdf-reader#readme
- Issues: https://github.com/kemy971/react-pdf-reader/issues
- npm.io page: https://npm.io/package/react-pdf-reader

## Dependencies (7)

- [react](https://npm.io/package/react.md) ^15.6.1
- [react-dom](https://npm.io/package/react-dom.md) ^15.6.1
- [waypoints](https://npm.io/package/waypoints.md) ^4.0.1
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [pdfjs-dist](https://npm.io/package/pdfjs-dist.md) ^1.10.83
- [prop-types](https://npm.io/package/prop-types.md) ^15.6.0
- [velocity-animate](https://npm.io/package/velocity-animate.md) ^1.5.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2017-10-24
- 0.1.7 — 2017-10-24
- 0.1.6 — 2017-07-31
- 0.1.5 — 2017-07-31
- 0.1.4 — 2017-07-30
- 0.1.3 — 2017-07-29
- 0.1.2 — 2017-07-29
- 0.1.1 — 2017-07-29
- 0.1.0 — 2017-07-29

## README

# React PDF Reader
[![npm version](https://badge.fury.io/js/react-pdf-reader.svg)](https://badge.fury.io/js/react-pdf-reader)
![Travis build](https://travis-ci.org/kemy971/react-pdf-reader.svg?branch=feature%2Ftravisci)
[![CircleCI](https://circleci.com/gh/kemy971/react-pdf-reader.svg?style=svg)](https://circleci.com/gh/kemy971/react-pdf-reader)

A React component to read PDF Document.

## Installation

### npm

```bash
npm install react-pdf-reader --save
```

### yarn

```bash
yarn add react-pdf-reader
```

## Usage
Import the component in your React app :
```js
import PDFReader from "react-pdf-reader";
```

```jsx
<PDFReader
    file="pdf/sample.pdf"
    renderType="canvas"
/>
```

Import TextLayer stylesheet : 
```js
import "react-pdf-reader/dist/TextLayerBuilder.css";
//OR 
import "react-pdf-reader/dist/sass/TextLayerBuilder.scss";
```
Or copy `/node_modules/react-pdf-reader/dist/TextLayerBuilder.css` in your static files folder and import :
```html
<link rel="stylesheet" href="css/TextLayerBuilder.css" />
```

Import default reader stylesheet ( Optional but recommended :) )  : 
```js
import "react-pdf-reader/dist/PdfReader.css";
//OR 
import "react-pdf-reader/dist/sass/PdfReader.scss";
```
Or copy `/node_modules/react-pdf-reader/dist/PdfReader.css` in your static files folder and import :
```html
<link rel="stylesheet" href="css/PdfReader.css" />
```

## Prop types
Prop|Description|Sample
 --- | --- | ---
file| Define the url of the PDF Document.|`file="pdf/sample.pdf"`
renderType| Define the type of the PDF display render. You have the choice between "canvas" and "svg". Default : `svg`|<ul><li> Make render by SVG :<br/> `renderType="svg"`</li><br/><li>Make render by canvas : <br/> `renderType="canvas"`</li></ul>

---
_Source: https://npm.io/package/react-pdf-reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._