如何自定义 PDF.js

发布于2024-11-08

How to customize PDF.js

PDF.js 是一个很棒的开源项目，它经常更新并且不断添加新功能，但是从外观上看它很丑陋，或者可以说它看起来已经过时了。从 PDF.js 获取最新的 PDF 功能和修复，但在演示方面拥有流畅的外观怎么样？

PdfJsKit 的 pdf 查看器并不引人注目，它不会直接更改 PDF.js 的代码，它只是在 iframe 中包含 PDF.js，并在运行时覆盖 HTML、JS 和 CSS，以提供光滑的现代外观和更好的 ui结构和可用性以及新功能。这样我们就可以轻松地将 PDF.js 更新到最新版本并获得所有错误修复和改进。

其他基于 PDF.js 的 pdf 查看器通常不会更新默认外观，而那些通常会由于分离成组件但部分实现它们或提供不良/部分 API 而错过功能。

入门

将软件包安装到您的项目中：

npm install pdfjskit

当安装包（或版本更新）时，PdfJsKit使用的资源（css、图像等）将自动从node_modules\pdfjskit\dist\pdfjskit复制到public\pdfjskit。您项目的 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并将内容替换为：


  
    PdfJsKit Vite Example

现在您可以运行开发 Web 服务器了：
```
npm run dev
```
将显示：
```
➜  Local:   http://localhost:5173/
➜  Network: use --host to expose
➜  press h   enter to show help    
```
使用 CTRL 键单击本地 URL 以启动浏览器。
您将看到页面中呈现了 PDF Viewer。