# @file-viewer/renderer-pdf 中文文档

规范地址：https://npmcn.com/package/%40file-viewer/renderer-pdf/

版本：3\.3\.3
npm 元数据更新时间：2026-10-31T11:12:02.061Z
中文译文更新时间：2026-11-14T17:42:09.007Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40file-viewer/renderer-pdf
原文对照：https://npmcn.com/package/%40file-viewer/renderer-pdf/?lang=original
项目主页：https://doc.file-viewer.app/guide/on-demand-renderers
源码仓库：https://github.com/flyfish-dev/file-viewer

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.7 MB，243 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：pdf-lib 1\.17\.1
- 首次发布：2026-06-23T06:20:36.152Z
- 最新版本发布：2026-10-31T11:12:01.734Z
- 近 30 天下载量：109652（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：60（近 12 个月 60 个）

## 中文简介

文件查看器由PDF.js提供动力的独立PDF渲染器插件.

## 安装

```sh
npm install @file-viewer/renderer-pdf
```

也可以使用：`pnpm add @file-viewer/renderer-pdf`、`yarn add @file-viewer/renderer-pdf`、`bun add @file-viewer/renderer-pdf`

## README

# @file-viewer/renderer-pdf

[English](https://github.com/flyfish-dev/file-viewer/blob/main/packages/renderers/pdf/README.md) · [简体中文](https://github.com/flyfish-dev/file-viewer/blob/main/packages/renderers/pdf/README.zh-CN.md)

Flyfish File Viewer 的独立 PDF renderer 包，基于 PDF.js，提供 PDF 页面渲染、导航、目录、搜索、缩放、打印和 HTML 导出能力。

## 用法

```ts
import FileViewer from '@file-viewer/vue3'
import { pdfRenderer } from '@file-viewer/renderer-pdf'

const options = {
  rendererMode: 'replace',
  renderers: pdfRenderer,
}
```

也可以和其他 renderer 一起组合：

```ts
const options = {
  rendererMode: 'replace',
  renderers: [pdfRenderer],
}
```

## PDF URL 读取

标准 PDF 渲染器在 Vanilla/Web Component、React、Svelte、jQuery 和 Vue 使用相同的 URL 策略。`pdf.streaming` 默认 `same-origin`；跨域或签名 URL 可显式设为 `true`，无扩展名 URL 同时提供 `filename: 'document.pdf'` 或 `type: 'pdf'`。此时直接交给 PDF.js，不先在 core 完整下载。Range 需要服务端支持；跨域还须通过 CORS 暴露 `Accept-Ranges`、`Content-Length`、`Content-Range`。

`pdf.streaming: false` 会先下载一次再预览。显式 buffer/file、自定义 `fetchFile` 仍优先提供字节；原 URL 保留为元数据，不会触发 PDF.js 重复下载。自定义仅支持 buffer 的渲染器继续遵循其能力声明。PDF.js 默认可在后台继续取流；如需仅按需读取 Range，同时设置 `pdf.disableStream: true` 和 `pdf.disableAutoFetch: true`。禁用自动预取需要同时禁用流读取；未配置时保留 PDF.js 默认值。

## 深色阅读

无需重载的实时更新适用于 renderer 观察到的主题属性、系统配色及 Vanilla core 的主题更新路径。框架组件与工具栏/controller 的选项更新可能重新初始化预览。

PDF 正文跟随 `options.theme`（`light`、`dark`、`system`），支持实时切换。深色阅读只在预览画布上应用颜色滤镜，图片颜色也会随之变化；需要保持原始配色时设置 `pdf.darkMode: false`，设为 `true` 则可独立强制深色阅读。原文件下载、打印和导出的画布像素仍保持原始颜色。

## 离线资源

PDF 预览依赖 PDF.js worker、cMaps、WASM、standard fonts，以及未嵌入中文字体的离线回退资源。资源路径沿用 `@file-viewer/core` 的统一 options：

```ts
const options = {
  renderers: pdfRenderer,
  pdf: {
    assetBaseUrl: '/workspace/',
    workerUrl: '/vendor/pdf/pdf.worker.mjs',
    cMapUrl: '/vendor/pdf/cmaps/',
    wasmUrl: '/vendor/pdf/wasm/',
    standardFontDataUrl: '/vendor/pdf/standard_fonts/',
    cjkFontFallbackPath: '/vendor/pdf/fonts/',
    identityFontRepair: true,
  },
}
```

默认未显式配置时，渲染器优先使用 Vite 等构建器提供的公开基址，并可从页面入口脚本回退识别部署子路径。因此应用部署在 `/workspace/`、当前 SPA 路由为 `/workspace/c/` 时，仍会请求 `/workspace/vendor/pdf/pdf.worker.mjs`。UMI、自定义代理或无法自动识别的构建环境可以设置 `pdf.assetBaseUrl: '/workspace/'` 固定全部 PDF 离线资源的基址。真实 Worker 在解析前通过 PDF.js API 握手确认版本；旧版本不匹配时会被销毁，并安全重试包内同版本 handler，不额外发送版本探测请求。项目未执行 `file-viewer-copy-assets`、未使用 `@file-viewer/vite-plugin`，或本地临时服务器把该路径回退成 HTML 时，也会使用同一兜底，避免 `Setting up fake worker failed` 直接中断预览。需要最佳性能、完整 cMap/standard fonts/WASM 解码或严格离线部署时，仍建议复制 viewer assets 并配置真实静态地址。当前锁定的 PDF.js 5.4 稳定线会通过 `wasmUrl` 本地加载 JBIG2、JPEG 2000、颜色管理等辅助资源；这些资源由 viewer assets 和 Vite 插件统一复制，不依赖公网。

`cjkFontFallback` 默认开启。PDF 引用了 `MicrosoftYaHei-Bold`、宋体、黑体或其他中文字体但没有嵌入字体数据时，渲染器优先使用本机字体；本机缺失时，会把原 PDF 字体名映射到 `@file-viewer/assets-standard` 提供的本地 Noto Sans SC 可变字体，并根据当前页实际文字只加载需要的 WOFF2 分片。Vite 插件会优先复用这份标准资源，避免在 renderer 中重复打包字体。首屏会在字体就绪后再渲染，后续页发现新字形时会自动重绘。可设为 `false` 完全关闭，或用 `cjkFontFallbackPath` 指向同结构的自托管字体目录。

`identityFontRepair` 也默认开启，用于少数把 TrueType 字形 ID 写入 `Identity-H`/`Identity-V`、却遗漏 `ToUnicode` 的异常 PDF。只有检测到中文字体替换和多个控制字符乱码时，渲染器才会懒加载修复模块；若文件内同时嵌入了可用的同族 TrueType 字体，就从其 cmap 重建内存预览所需的 Unicode 映射。修复只作用于预览副本，不覆盖原始文件和下载源；无法安全修复时继续使用原预览。可设为 `false` 关闭。

字体遗漏 `FontDescriptor` 时，`UniGB-UCS2-H/V`、GBK、Big5 等预定义 CID CMap 仍按多字节编码解码，并保留文件提供的 `ToUnicode` 映射。这类 PDF 无需额外安装 Identity 字体修复能力，原始 PDF 字节也不会改写。

## 迁移说明

直接启动真实 Worker，不再额外读取版本前缀或重复下载 Worker。 PDF.js 在解析前通过 API 握手检查版本；不匹配时销毁旧 Worker，并用保留的输入安全重试包内同版本回退。 主线程回退使用异步资源读取，不依赖窗口中不允许的同步二进制 XHR。

PDF 渲染已经从 `@file-viewer/core` 移入本包，`pdfjs-dist` 只由 `@file-viewer/renderer-pdf` 声明。只安装 core 或标准组件包时不会再拉取 PDF.js；需要 PDF 预览时请显式装配本 renderer，或使用 `@file-viewer/preset-all`。

发布产物会把 Apache-2.0 的 PDF.js runtime 内封到 `dist/vendor/pdfjs`，并在打包前隔离 PDF.js 内部 webpack bootstrap。`provenance.json` 会记录应用声明补丁后的源文件哈希、变换次数和产物哈希，因此 webpack 4 消费项目不需要再为 renderer 内部路径配置 loader。

内封运行时还包含 PDF.js 5.4.624 的文档初始化取消补丁，避免快速切换文件时主线程降级路径产生未处理的 Promise 异常；正常解析和密码错误仍会报告。补丁原文保留在 `dist/vendor/pdfjs/patches/`，其哈希记入 `provenance.json`。`pnpm verify:worker-lifecycle` 使用 Chromium/WebKit 分别验证真实 Worker 和主线程降级路径的取消、后续渲染及损坏文件报错。

## 鼠标拖拽浏览

设置 `options.pdf.handTool: true`，可在 PDF 阅读区按住鼠标左键拖动页面。默认关闭， 保留原有文字选择行为。触摸滚动与双指缩放、链接、表单控件、滚动条及带修饰键的操作 保持原生行为。

```ts
const options = { pdf: { handTool: true } }
```

## 页面方向与打印

适配缩放、侧栏和首页缩略图、导出图片及打印均叠加 PDF 页面原有旋转角度 与查看器旋转偏移。视图状态中的 `rotation` 仍表示查看器偏移，不包含文件 中的原始旋转。混合尺寸和方向的页面使用独立 CSS 页面规则打印，不改写 源 PDF。打印对话框的纸张覆盖设置仍可能强制统一尺寸。

## 常见问题

### @file-viewer/renderer-pdf 是什么？

文件查看器由PDF\.js提供动力的独立PDF渲染器插件\.

### 如何安装 @file-viewer/renderer-pdf？

在项目目录运行 npm install @file-viewer/renderer-pdf，或使用 pnpm add / yarn add / bun add。

### @file-viewer/renderer-pdf 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @file-viewer/renderer-pdf 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @file-viewer/renderer-pdf 可以商用吗？

@file-viewer/renderer-pdf 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @file-viewer/renderer-pdf 的下载量有多少？

根据 npm 官方下载统计，@file-viewer/renderer-pdf 在 2026/10/15 – 2026/11/13 这 30 天内被下载 109,652 次，日均约 3,655 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @file-viewer/renderer-pdf 还在维护吗？

最新版本 3\.3\.3 发布于 2026/10/31（14 天前）；至今共发布 60 个版本，其中过去 12 个月发布了 60 个；首次发布于 2026/06/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。