发布一个react组件——react-read-pdf，用于在移动端展示PDF文件

• Z时代
• 2024-01-10
• 分类：综合

PC端的浏览器对于PDF文件的展示没有太大的问题，给定一个PDF的链接，就可以用浏览器默认的展示样式来展示和渲染PDF文件的内容。比如一个"http://www.baidu.com/test/pdf"。 如何在移动端展示这个文件。为了在移动端展示和渲染PDF文件的内容，本文在pdfjs的基础上实现了一个简单的react组件，用于展示和渲染PDF文件。

• 将这个react组件，以npm包的形式发布。

• 这个组件的项目地址为：https://github.com/forthealllight/react-read-pdf
  

  （如果想看使用的例子，直接下载这个代码或者clone，然后npm install和npm start即可）

React-read-pdf

使用React16.5编写的组件，用于在移动设备和PC端显示和渲染PDF文件

特点

• Simple: 使用简单方便，仅仅是一个react组件

• Mobile-friendly: 自适应多种移动端的设备，包括手机，平板和其他的移动办公设备

浏览器支持

• IE 10+
• Firefox 3.6+
• Chrome 6+
• Safari 6+
• Opera 11.5+
• iOS Safari 6.1+
• Android Browser 3+

快速开始

1. 将 react-read-pdf引入你的react项目中

(在你的项目中比如先引入react,且必须保证React的版本必须在15.0以上)

安装react-read-pdf包

npm install --save react-read-pdf

在PC端建议使用PDFReader:

import React from 'react';
import { PDFReader } from 'react-read-pdf';

在移动端建议使用MobilePDFReader,可以自适应各种移动设备:

import React from 'react';
import { MobilePDFReader } from 'react-read-pdf';

2. 引入之后，再来看简单的使用:

import { MobilePDFReader } from 'react-read-pdf';
export default class Test extends Component{
  render(){
    return <div style={{overflow:'scroll',height:600}}>
            <MobilePDFReader url="http://localhost:3000/test.pdf"/>
           </div>
  }
}

import ReactDOM from 'react-dom';
import Test from './test'
ReactDOM.render(<Test />, document.getElementById('root'));

react-read-pdf 自适配于各种不同的移动设备，包括手机、平板和其他移动办公设备,下图是利用react-read-pdf在iphoneX上展示PDF的一个例子。

文档

react-read-pdf 这个npm包主要包括了两个不同类型的组件 PDFReader 和 MobilePDFReader.

? PDFReader

import { PDFReader } from 'react-read-pdf'
...
<PDFReader url={"http://localhost:3000/test.pdf"} ...>

PDFReader组件中的属性

url

**PDFReader**组件的url属性

类型:

• string : 字符串，表示PDF文件的绝对或者相对地址
• object : 对象，有下列的属性

属性:

onDocumentComplete

**PDFReader**的onDocumentComplete属性

Type:

• function(totalPage)

onDocumentComplete的类型是一个函数, 这个函数的第一个参数表示的是PDF文件的总页数。

注意事项

PDFReader组件的url属性可以是字符串或者是对象。

下面两种方式都是被允许的。

其一是 :

 <MobilePDFReader url="http://localhost:3000/test.pdf"/>

另外一种方式是 :

 <MobilePDFReader url={url:"http://localhost:3000/test.pdf"}/>

? MobilePDFReader

import { MobilePDFReader } from 'react-read-pdf'
...
<MobilePDFReader url={"http://localhost:3000/test.pdf"} ...>

MobilePDFReader组件中的属性

onDocumentComplete

**MobilePDFReader**的onDocumentComplete属性

类型: 函数

• function(totalPage,title,otherObj)

函数的参数:

注意事项

scale的默认值为“auto”,强烈推荐将scale的值设置成“auto”，这样可以根据移动设备的大小自适应的改变scale的值。

开发者选项

• React (16.x)

• Webpack (4.x)

• Typescript (3.x)

• Hot Module Replacement (HMR) using React Hot Loader (4.x)

• Babel (7.x)

• Less

• React-css-modulesusing css-modules

• Jest - Testing framework for React applications

• Production build script
• Image loading/minification using Image Webpack Loader

• Typescript compiling using Typescript Loader (5.x)
• Code quality (linting) for Typescript and LESS/CSS.

安装

1. Clone/download repo

2. yarn install (or npm install for npm)

使用

Development

yarn run start-dev

• Build app continuously (HMR enabled)
• App served @ http://localhost:8080

Production

yarn run start-prod

• Build app once (HMR disabled)
• App served @ http://localhost:3000

指令列表

Note: replace yarn with npm if you use npm.

以上是 发布一个react组件——react-read-pdf，用于在移动端展示PDF文件 的全部内容， 来源链接： utcz.com/z/381233.html