# @lemon-clown-wpg/react-pdf-viewer

> a simple react pdf viewer

Latest version **0.0.2** (published 2020-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lemon-clown-wpg/react-pdf-viewer
pnpm add @lemon-clown-wpg/react-pdf-viewer
yarn add @lemon-clown-wpg/react-pdf-viewer
bun add @lemon-clown-wpg/react-pdf-viewer
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; large bundle; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2020-03-05 |
| First published | 2020-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >= 12.16.0 |
| Dependencies | 2 |
| Unpacked size | 16.8 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | lemon-clown |
| Maintainers | lemonclown |
| Keywords | react, typescript, pdf viewer |

## Links

- npm: https://www.npmjs.com/package/@lemon-clown-wpg/react-pdf-viewer
- Repository: https://github.com/lemon-clown/web-play-ground
- Homepage: https://github.com/lemon-clown/web-play-ground/tree/master/packages/react-pdf-viewer#readme
- Issues: https://github.com/lemon-clown/web-play-ground/issues
- npm.io page: https://npm.io/package/@lemon-clown-wpg/react-pdf-viewer

## Dependencies (2)

- [react-pdf](https://npm.io/package/react-pdf.md) ^5.0.0-beta.2
- [@types/react-pdf](https://npm.io/package/@types/react-pdf.md) ^4.0.3

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.2 (latest) — 2020-03-05
- 0.0.1 — 2020-03-05

## README

[![npm version](https://img.shields.io/npm/v/@lemon-clown-wpg/react-pdf-viewer.svg)](https://www.npmjs.com/package/@lemon-clown-wpg/react-pdf-viewer)
[![npm download](https://img.shields.io/npm/dm/@lemon-clown-wpg/react-pdf-viewer.svg)](https://www.npmjs.com/package/@lemon-clown-wpg/react-pdf-viewer)
[![npm license](https://img.shields.io/npm/l/@lemon-clown-wpg/react-pdf-viewer.svg)](https://www.npmjs.com/package/@lemon-clown-wpg/react-pdf-viewer)


A pdf viewer

![pdf-viewer.png][]


See [sourcecodes in github](https://github.com/lemon-clown/web-play-ground/tree/master/packages/react-pdf-viewer#readme) to get more information.


# Usage

  * Install
    ```shell
    yarn add @lemon-clown-wpg/react-pdf-viewer
    # you aslo should install peerDependencies if the terminal prompts for a warnning
    ```

  * Use in React project
    ```typescript
    import React from 'react'
    import ReactDOM from 'react-dom'
    import { PDFViewer } from '@lemon-clown-wpg/react-pdf-viewer'
    import '@lemon-clown-wpg/react-pdf-viewer/lib/esm/index.css'


    const pdfStyle: React.CSSProperties = {
      width: '100vw',
      height: '100vh',
    }


    // index.tsx
    ReactDOM.render(
      <PDFViewer
        style={ pdfStyle }
        fileUrl="/files/demo.pdf"
      />
      , document.getElementById('root')
    )
    ```

# Options

   property               | required  | type            | default
  :-----------------------|:---------:|:----------------|:-------------
   fileUrl                | `true`    | `string`        |
   fileName               | `false`   | `string`        | `/(?:[^/\\]*[/\\])?([^/\\]+?)(?:#[\s\S]*)?$/.exec(fileUrl)[1] || ''`
   direction              | `false`   | `'ltr' | 'rtr'` | `'ltr'`
   MIN_SCALING            | `false`   | `number`        | 0.50
   MAX_SCALING            | `false`   | `number`        | 4.00
   ZOOM_STEP              | `false`   | `number`        | 0.10
   selectOptions          | `false`   | `number[]`      | [ 0.50, 0.75, 1.00, 1.25, 1.50, 2.00, 3.00, 4.00 ]
   onDocumentLoadError    | `false`   | `Function`      | `undefined`
   onDocumentLoadSuccess  | `false`   | `Function`      | `undefined`

  * `fileUrl`: url of pdf file
  * `fileName`: filename of pdf file
  * `direction`: the text direction
  * `MIN_SCALING`: minimum scaling
  * `MAX_SCALING`: maximum scaling
  * `ZOOM_STEP`: the size of the zoom step
  * `scaleOptions`: Options for the drop-down box
  * `onDocumentLoadError`: Function called in case of an error while loading a document.
    - `onDocumentLoadError?: (error: Error) => void`
  * `onDocumentLoadSuccess`: Function called when the document is successfully loaded.
    - `onDocumentLoadSuccess?: (pdf: pdfjs.PDFDocumentProxy) => void`



[pdf-viewer.png]: https://raw.githubusercontent.com/lemon-clown/web-play-ground/master/packages/react-pdf-viewer/doc/screenshots/pdf-viewer.png

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