# pdf-viewer-root

> a pdf reader can use for react or vue

Latest version **1.2.3** (published 2024-02-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install pdf-viewer-root
pnpm add pdf-viewer-root
yarn add pdf-viewer-root
bun add pdf-viewer-root
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2024-02-20 |
| First published | 2023-08-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | yangxuy, Destrokhen |
| Maintainers | destrokhen |
| Keywords | shadow-root, vue, react, angular |

## Links

- npm: https://www.npmjs.com/package/pdf-viewer-root
- Repository: https://github.com/Destrokhen-main/pdf-viewer-root
- npm.io page: https://npm.io/package/pdf-viewer-root

## 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

- 1.2.3 (latest) — 2024-02-20
- 1.2.0 — 2023-08-31
- 1.1.0 — 2023-08-30
- 1.0.2 — 2023-08-30
- 1.0.1 — 2023-08-30
- 1.0.0 — 2023-08-30

## README

## pdf-viewer-root

This library is based on <a href="https://www.npmjs.com/package/@yangxuy/pdf-reader">@yangxuy/pdf-reader</a> but has some new features

### Setup:

```
yarn add pdf-viewer-root
```

```
npm i pdf-viewer-root
```

### Usage

vue 2 / 3:

```

<template>
<pdf-viewer-root :url="url" />
</template>

<script>
import "pdf-viewer-root"
</script>

```

react:

```
import pdf from "./assets/1.pdf";
import "pdf-viewer-root";
import { useRef } from "react";
import React from "react";

function App() {
    const div = useRef<any>();

    return (
        <div className="App" ref={div}>
            {React.createElement("pdf-viewer-root", { url: pdf })}
        </div>
    );
}

export default App;
```


### component attributes

| attr          | description                                                   | default | Type          |Not working yet |
|---------------|---------------------------------------------------------------|---------|---------------|----------------|
| url           | Link to the file (you can send a blob)                        |         | string        |                |
| page          | Page number, from 1 to infinity                               | 1       | number        |                |
| mode          | Display mode if 1 shows by page. If 2 shows all pages at once | 1       | number        |                |
| scale         | pdf size on screen. from 10 to 100                            | 100     | number        |        -       |
| dpi           | Manages the quality                                           | 300     | number        |        -       |
| onSuccess     | When the pdf is loaded, this event will be called             | -       | (pdf) => {}   |                |
| onError       | When the pdf gives an error, this event will be called        | -       | (error) => {} |                |
| debug         | Log info in console                                           | false   | boolean       |                |
| loadingtext   | Text in loadingComponent                                      |'loading'| string        |                |

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