hy-pdfh5

v1.0.1

Published

9 months ago

JS plugin of preview PDF for mobile. web/h5/移动端PDF预览手势缩放插件

Downloads

0High
0Medium
0Low

wsaxq

pdfh5.js

1、有问题可以加Q群咨询，技术交流群，也可以探讨技术，另有微信群可以问群主拉入微信群

2、如果有报错，请复制example运行，然后对照相关文件，以及package.json，缺什么补什么

3、如果有某些字体显示不了，那可能是pdf.js缺少相关字库解析，可以尝试更改cMapUrl，建议去官方地址找版本

4、如果IOS下pdf显示不了，安卓却可以，可能是pdf精度过高导致，Safari浏览器canvas渲染绘制图片宽高不能超过16777216，超过会不显示

react、vue均可使用

example/test是vue使用示例

example/vue3demo是vue3使用示例

example/vite4vue3是vite4+vue3+ts使用示例

example/react-test是react使用示例

pdfh5.js示例

更新信息

2024.02.29 更新：修复部分bugs。

pdfh5在线预览（建议使用谷歌浏览器F12手机模式打开预览）

https://www.gjtool.cn/pdfh5/pdf.html?file=https://www.gjtool.cn/pdfh5/git.pdf

快速使用（有两种方式）

一、script标签引入方式（需下载本项目文件夹css/pdfh5.css、js内所有文件）

1.引入css

<link rel="stylesheet" href="css/pdfh5.css" />

2.创建div

<div id="demo"></div>

3.依次引入js（需引用本项目的js,不要引用官方的pdf.js,jquery可以引用其它版的）

<script src="js/pdf.js" type="text/javascript" charset="utf-8"></script>
<script src="js/pdf.worker.js" type="text/javascript" charset="utf-8"></script>
<script src="js/jquery-2.1.1.min.js" type="text/javascript" charset="utf-8"></script>
<script src="js/pdfh5.js" type="text/javascript" charset="utf-8"></script>

4.实例化

var pdfh5 = new Pdfh5('#demo', {
  pdfurl: "./default.pdf"
});

二、npm安装方式（适应于vue）, react使用方法类似vue（example/react-test是react使用示例）

1.安装

npm install pdfh5

2.使用

<template>
  <div id="app">
	<div id="demo"></div>
  </div>
</template>
<script>
  import Pdfh5 from "pdfh5";
  export default {
    name: 'App',
	data() {
	  return {
	    pdfh5: null
	  };
	},
	mounted() {
		//实例化
	  this.pdfh5 = new Pdfh5("#demo", {
		pdfurl: "../../static/test.pdf",
		// cMapUrl:"https://unpkg.com/[email protected]/cmaps/",
		// responseType: "blob" // blob arraybuffer
	  });
	  //监听完成事件
	  this.pdfh5.on("complete", function (status, msg, time) {
		console.log("状态：" + status + "，信息：" + msg + "，耗时：" + time + "毫秒，总页数：" + this.totalNum)
		//禁止手势缩放
		this.pdfh5.zoomEnable(false);
	  })
	}
  }
</script>

<style>
	@import "pdfh5/css/pdfh5.css";
	*{
	padding: 0;
	margin: 0;
	}
	html,body,#app {
	width: 100%;
	height: 100%;
	}
</style>

注意：如果css引用报错的话，按下面的方式引用。

  import Pdfh5 from "pdfh5";
  import "pdfh5/css/pdfh5.css";

API接口方法

实例化

pdfh5实例化的时候传两个参数，selector选择器，options配置项参数，会返回一个pdfh5实例对象，可以用来操作pdf，监听相关事件

var pdfh5 = new Pdfh5(selector, options);

|参数名称 |类型 |取值 |是否必须 |作用 | |:---: |:---: |:---: |:---: |:---: | |selector | String | - | √ |pdfh5的容器选择器 | |options | Object | - | × |pdfh5的配置项参数 |

options配置项参数列表

示例： 配置项参数 pdfurl

var pdfh5 = new Pdfh5('#demo', {
	pdfurl: "./default.pdf"
});

|参数名称 |类型 |取值 |作用 | |:---: |:---: |:---: |:---: | |pdfurl | String | - |pdf地址 | |responseType | String |blob 、 arraybuffer 默认 blob |请求pdf数据格式 | |URIenable | Boolean |true、false，默认false | true开启地址栏file参数 | |data | Array(arraybuffer) | - |pdf文件流，与pdfurl二选一(二进制PDF数据。使用类型化数组（Uint8Array）可以提高内存使用率。如果PDF数据是BASE64编码的，请先使用atob（）将其转换为二进制字符串。) | |renderType | String |"canvas"、"svg"，默认"canvas" |pdf渲染模式 | |pageNum | Boolean |true、false，默认true |是否显示左上角页码 | |backTop | Boolean |true、false，默认true |是否显示右下角回到顶部按钮 | |maxZoom | Number |最大倍数3 |手势缩放最大倍数 | |scale | Number |最大比例5，默认1.5 |pdf渲染的比例 | |scrollEnable | Boolean |true、false，默认true |是否允许pdf滚动 | |zoomEnable | Boolean |true、false，默认true |是否允许pdf手势缩放 | |cMapUrl | String | " |解析pdf时，特殊情况下显示完整字体的cmaps文件夹路径，例如 cMapUrl:"https://unpkg.com/[email protected]/cmaps/" | |limit | Number | 默认0 |限制pdf加载最大页数 | |logo | Object |{src:"pdfh5.png",x:10,y:10,width:40,height:40}src水印图片路径（建议使用png透明图片），width水印宽度，height水印高度，以每页pdf左上角为0点，x、y为偏移值。默认false|给每页pdf添加水印logo（canvas模式下使用） | |goto | Number | 默认0 |加载pdf跳转到第几页 | |textLayer | Boolean | true、false，默认false |是否开启textLayer，可以复制文本（canvas模式下使用）【处于测试阶段，位置偏移严重】 | |background | Object | {color:"#fff",image:"url('pdfh5.png')",repeat:"no-repeat",position:"left top",size:"40px 40px"}，和css的background属性语法相同，默认false |是否开启背景图模式 |

pdf请求示例

new Pdfh5('#demo', {
	pdfurl: "git.pdf",
	// responseType: "blob" // blob arraybuffer
});

pdf文件流或者buffer已经得到，如何渲染

 new Pdfh5('#demo', {
 	data: blob,  //blob arraybuffer
 });

methods 方法列表

示例： 是否允许pdf滚动

pdfh5.scrollEnable(true) //允许pdf滚动
pdfh5.scrollEnable(false) //不允许pdf滚动

on方法监听所有事件-事件名列表

示例： 监听pdf准备开始渲染，此时可以拿到pdf总页数

pdfh5.on("ready", function () {
	console.log("总页数：" + this.totalNum)
})

打赏榜单

JayLin ￥6.66
靓仔城￥6.67
南蓝￥8.80
我是太阳￥29.99
*小波￥1.00
*鑫 ¥9.99
*手 ¥9.99
*勇￥19.99
*爷 ¥5.00
*超 ¥20.00
3*Y ¥5.00
*阳 ¥5.00
**雄 ¥5.00
A*r ¥1.23
*客 ¥5.00
*运 ¥66.66
*辰 ¥30.00
*黎 ¥6.66+¥5.00
**福 ¥6.66
*🏀 ¥6.66+¥1.00
*阳 ¥10.00
自闭中 ¥16.66+¥16.00
*焕 ¥6.66
*人 ¥5.00
*。 ¥5.20
半*) ¥5.00
*1 ¥15.00
*蕾 ¥16.66+¥8.80
*军 ¥10.00
**强 ¥58.88
E*y ¥6.60
J*u ¥13.00
A*a ¥50.00
*东 ¥8.80
j*y ¥9.99
*宇 ¥6.66
*涛￥1.00
*. ￥10.00
*☺ ￥6.66
*霸￥6.66
a*r ￥20.00
木槿(**耀) ￥50.00