https://github.com/kemy971/react-pdf-reader
PDF Reader - React JS Component
https://github.com/kemy971/react-pdf-reader
pdf pdf-document pdf-viewer pdfjs reactjs
Last synced: 11 months ago
JSON representation
PDF Reader - React JS Component
- Host: GitHub
- URL: https://github.com/kemy971/react-pdf-reader
- Owner: kemy971
- Created: 2017-07-25T07:56:37.000Z (almost 9 years ago)
- Default Branch: develop
- Last Pushed: 2017-10-24T15:10:24.000Z (over 8 years ago)
- Last Synced: 2024-11-14T10:50:44.718Z (over 1 year ago)
- Topics: pdf, pdf-document, pdf-viewer, pdfjs, reactjs
- Language: JavaScript
- Size: 1.58 MB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React PDF Reader
[](https://badge.fury.io/js/react-pdf-reader)
[](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
```
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
```
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
```
## 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`|
- Make render by SVG :
`renderType="svg"` - Make render by canvas :
`renderType="canvas"`