https://github.com/sugarshin/react-pdfobject
A React component for PDFObject
https://github.com/sugarshin/react-pdfobject
component pdfobject react
Last synced: over 1 year ago
JSON representation
A React component for PDFObject
- Host: GitHub
- URL: https://github.com/sugarshin/react-pdfobject
- Owner: sugarshin
- Created: 2018-12-19T03:58:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-24T06:37:02.000Z (over 1 year ago)
- Last Synced: 2025-03-29T06:01:38.364Z (over 1 year ago)
- Topics: component, pdfobject, react
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/react-pdfobject
- Size: 412 KB
- Stars: 38
- Watchers: 1
- Forks: 10
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-pdfobject
[![CircleCI][circleci-image]][circleci-url]
[![Codecov][codecov-image]][codecov-url]
[![npm version][npm-image]][npm-url]
[![License][license-image]][license-url]
A React component for [PDFObject](https://github.com/pipwerks/PDFObject) .
```sh
npm install react-pdfobject
```
## Usage
```ts
import * as React from 'react'
import { PDFObject } from 'react-pdfobject'
```
## Props
```ts
interface Props {
url: string;
containerId?: string;
containerProps?: React.HTMLProps;
width?: string;
height?: string;
page?: string | number;
id?: string;
fallbackLink?: string | false;
pdfOpenParams?: OpenParams;
PDFJS_URL?: string;
forcePDFJS: boolean;
assumptionMode: boolean;
}
export interface OpenParams {
page?: number;
zoom?: ZoomMode;
nameddest?: string;
pagemode?: PageMode;
view?: ViewMode;
}
export type ZoomMode = 'scale' | 'scale,left,top';
export type PageMode = 'bookmarks' | 'thumbs' | 'none';
export type ViewMode =
| 'Fit'
| 'FitH'
| 'FitH,top'
| 'FitV'
| 'FitV,left'
| 'FitB'
| 'FitBH'
| 'FitBH,top'
| 'FitBV'
| 'FitBV,left';
```
## API / Static Methods Supported
#### PDFObject.supportsPDFs [Function]
```ts
if(PDFObject.supportsPDFs){
console.log("Yay, this browser supports inline PDFs.");
} else {
console.log("Boo, inline PDFs are not supported by this browser");
}
```
#### PDFObject.pdfobjectversion [Function]
```ts
console.log(PDFObject.pdfobjectversion); //"2.1.1"
```
ref: https://pdfobject.com/#api
## License
[MIT][license-url]
© sugarshin
[circleci-image]: https://circleci.com/gh/sugarshin/react-pdfobject/tree/master.svg?style=svg&circle-token=5faa6707fd0e1803cf6e01a16b6bacaba92b23b3
[circleci-url]: https://circleci.com/gh/sugarshin/react-pdfobject/tree/master
[codecov-image]: https://codecov.io/gh/sugarshin/react-pdfobject/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/sugarshin/react-pdfobject
[npm-image]: https://img.shields.io/npm/v/react-pdfobject.svg?style=flat-square
[npm-url]: https://www.npmjs.org/package/react-pdfobject
[license-image]: https://img.shields.io/:license-mit-blue.svg?style=flat-square
[license-url]: https://sugarshin.mit-license.org/