如何自定义PDFjs
pdf.js 是一个很棒的开源项目,它经常更新并且不断添加新功能,但是从外观上看它很丑陋,或者可以说它看起来已经过时了。从 pdf.js 获取最新的 pdf 功能和修复,同时在演示文稿方面拥有流畅的外观怎么样?
pdfjskit 的 pdf 查看器并不引人注目,它不会直接更改 pdf.js 的代码,它只是在 iframe 中包含 pdf.js,并在运行时覆盖 html、js 和 css,以提供光滑的现代外观和更好的用户界面结构和可用性以及新功能。这样我们就可以轻松地将 pdf.js 更新到最新版本并获得所有错误修复和改进。
其他基于 pdf.js 的 pdf 查看器通常不会更新默认外观,而那些通常会由于分离成组件但部分实现它们或提供不良/部分 api 而错过功能。
入门
将软件包安装到您的项目中:
npm install pdfjskit
当安装包(或版本更新)时,pdfjskit使用的资源(css,图像等)将自动从node_modulespdfjskitdistpdfjskit复制到publicpdfjskit。您项目的 public 子目录是 web 资源的常见位置,但如果您的 js 框架具有不同的目录结构,您可以将资源移动到其他位置。
默认情况下,pdfjskit 从相对于主机页面的 pdfjskit 子目录加载资源,但您可以通过将自定义librarypath 选项传递给 pdfviewer 构造函数来更改此路径。
用法
import pdfviewer from "pdfjskit"; var pdfviewer = new pdfviewer({ documenturl: "pdfjskit/sample.pdf", width: "80%", height: 720, resizable: true, language: "en-us", theme: "slate, classic-dark" }); pdfviewer.render(document.getelementbyid("container"));
请注意,npm 包包含 es6 模块 pdfjskit.min.mjs,github dist/pdfjskit 目录和此处提供的开发人员包中还提供了脚本版本 pdfjskit.min.js。
在带有 vite 的纯 js 项目中使用 pdfjskit
您可以将任何 js 框架(react、vue、angular、svelte、blazor 等)与 pdfjskit 一起使用,但是为了在本文中简单起见,我将展示普通 js 项目的用法。
对于普通的 js 项目,我建议使用 vite,这样你就可以轻松地从 html 文件中的模块导入:
-
创建vite项目模板:
npm create vite@latest
选择设置:
✔ project name: … pdfjskit-vite-example ✔ select a framework: › vanilla ✔ select a variant: › javascript
-
将以您的项目名称创建的子目录,请执行以下操作:
cd pdfjskit-vite-example npm install npm install pdfjskit
-
编辑index.html并将内容替换为:
<!doctype html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> <title>pdfjskit vite example</title> </head> <body> <div id="container"></div> <script type="module"> import pdfviewer from "pdfjskit"; var pdfviewer = new pdfviewer({ documenturl: "pdfjskit/sample.pdf", width: "80%", height: 720, resizable: true, language: "en-us", theme: "slate, classic-dark" }); pdfviewer.render(document.getelementbyid("container")); </script> </body> </html>
-
现在您可以运行开发网络服务器:
npm run dev
将显示:
➜ Local: http://localhost:5173/ ➜ Network: use --host to expose ➜ press h + enter to show help
使用 ctrl 键单击本地 url 以启动浏览器。
您将看到页面中呈现了 pdf viewer。
文档
- html api 文档
- markdown api 文档
- 知识库
现场演示
- 模块捆绑测试
- 脚本包测试
链接:
- github
- npm
以上就是如何自定义PDFjs的详细内容,更多请关注其它相关文章!