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

PDF 生成器 Capacitor 插件

通过 HTML 模板生成用于发票、报告和收据的 PDF 文档

安装

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

指南

如何在 Capacitor 中使用 PDF Generator

在设备上测试

下载 Capgo App,然后扫描二维码 code。

PDF Generator 插件预览二维码 code

使用 @capgo/capacitor-pdf-generator

在 iOS 和 Android 上通过 HTML 字符串或 URL 生成 PDF 文件。

安装

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

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { PdfGenerator } from '@capgo/capacitor-pdf-generator';

API 概览

方法 描述
fromURL 根据提供的 URL 生成 PDF。
fromData 根据原始 HTML 字符串生成 PDF。

示例

fromURL()

根据提供的 URL 生成 PDF。

import { PdfGenerator } from '@capgo/capacitor-pdf-generator';

const result = await PdfGenerator.fromURL({ url: 'https://example.com' });
console.log(result);

fromData()

根据原始 HTML 字符串生成 PDF。

import { PdfGenerator } from '@capgo/capacitor-pdf-generator';

const result = await PdfGenerator.fromData({ data: 'data' });
console.log(result);

完整参考文档

继续使用 @capgo/capacitor-pdf-generator

如果你正在使用 使用 @capgo/capacitor-pdf-generator 要规划存储和文件处理,请将其与 @capgo/capacitor-pdf-generator 关于 @capgo/capacitor-pdf-generator 的实现细节, 快速入门 有关“入门指南”中的实现细节, @capgo/capacitor-data-storage-sqlite 关于 @capgo/capacitor-data-storage-sqlite 中的实现细节, 使用 @capgo/capacitor-data-storage-sqlite 关于使用 @capgo/capacitor-data-storage-sqlite 的原生能力,以及 @capgo/capacitor-file 关于 @capgo/capacitor-file. 的实现细节

常见问题

PDF Generator 插件常见问题

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

运行 "bun add @capgo/capacitor-pdf-generator" (或 "npm install @capgo/capacitor-pdf-generator"),然后运行 "bunx cap sync",以便 iOS 和 Android 项目同步原生的 code。在你的应用 code 中从 "@capgo/capacitor-pdf-generator" 导入即可。

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

支持。PDF Generator 是一个 Capacitor 插件,因此它支持任何在 Capacitor 中运行的 Web 框架,包括 Ionic、React、Vue、Angular、Svelte 以及原生 JavaScript。

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

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

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

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

我可以在无需经过 App Store 审核的情况下,更新使用了 PDF Generator 的 code 吗?

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

无需等待 App Store 审核,即可快速发布 PDF Generator 的更新

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

开始使用 Capgo