跳转至正文
@capgo/capacitor-pdf-viewer 文件与存储 开源

PDF 查看器 Capacitor 插件

在 iOS、Android 和 Web 端嵌入原生 PDF 查看,支持路径、URL、base64、内联模式和密码

安装

bun add @capgo/capacitor-pdf-viewer bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-pdf-viewer
  • pnpm add @capgo/capacitor-pdf-viewer
  • yarn add @capgo/capacitor-pdf-viewer

指南

如何在 Capacitor 中使用 PDF Viewer

使用 @capgo/capacitor-pdf-viewer

在 iOS (PDFKit)、Android (Pdfium) 和 Web 上原生查看 PDF,支持路径、URL、base64 和内联模式。

安装

bun add @capgo/capacitor-pdf-viewer
bunx cap sync

插件暴露的内容

  • open - 从文件、路径、URL 或 base64 源打开 PDF。
  • close - 关闭当前查看器并移除所有遮罩层。
  • goToPage - 跳转到从 1 开始计数的页码。
  • setZoom - 设置缩放倍数。
  • getPluginVersion - 获取原生或 Web 实现的版本标识。
  • addListener - 监听 load、pageChange、error、close 和 linkTap 事件。

用法示例

open

import { PdfViewer } from '@capgo/capacitor-pdf-viewer';

await PdfViewer.addListener('pageChange', ({ page, pageCount }) => {
  console.log(`Page ${page} of ${pageCount}`);
});

const { pageCount } = await PdfViewer.open({
  source: 'https://example.com/manual.pdf',
  mode: 'fullscreen',
  scrollMode: 'continuous',
  page: 1,
});

console.log(`Opened ${pageCount} pages`);

close

import { PdfViewer } from '@capgo/capacitor-pdf-viewer';

await PdfViewer.close();

完整参考

常见问题

PDF Viewer 插件常见问题

如何在 Capacitor 应用中安装 PDF Viewer 插件?

运行 "bun add @capgo/capacitor-pdf-viewer"(或 "npm install @capgo/capacitor-pdf-viewer"),然后运行 "bunx cap sync",让 iOS 和 Android 项目加载原生 code。再在应用 code 中从 "@capgo/capacitor-pdf-viewer" 导入它。

@capgo/capacitor-pdf-viewer 是否支持 React、Vue 和 Angular?

是的。PDF Viewer 是一个 Capacitor 包,因此它适用于任何运行在 Capacitor 中的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-pdf-viewer 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-pdf-viewer 是免费且开源的吗?

是的。源代码(code)在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-pdf-viewer/,并且可以从 npm 免费安装该包。欢迎提交 Bug 报告和 Pull Request。

我能否在不经过 App Store 审核的情况下,更新使用 PDF Viewer 的 code?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核即可发布 PDF Viewer 更改

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo