# @capgo/capacitor-pdf-generator 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-pdf-generator/

版本：8\.0\.50
npm 元数据更新时间：2026-11-09T07:24:57.394Z
中文译文更新时间：2026-11-09T03:25:03.856Z
软件包许可：MPL-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-pdf-generator
原文对照：https://npmcn.com/package/%40capgo/capacitor-pdf-generator/?lang=original
项目主页：https://capgo.app/docs/plugins/pdf-generator/
源码仓库：https://github.com/Cap-go/capacitor-pdf-generator

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

- 包体积（解压后）：78.2 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-10-16T04:01:48.644Z
- 最新版本发布：2026-11-09T07:24:57.136Z
- 近 30 天下载量：50556（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：55（近 12 个月 51 个）

## 中文简介

从iOS和Android上的HTML字符串或URL生成PDF文件.

## 安装

```sh
npm install @capgo/capacitor-pdf-generator
```

也可以使用：`pnpm add @capgo/capacitor-pdf-generator`、`yarn add @capgo/capacitor-pdf-generator`、`bun add @capgo/capacitor-pdf-generator`

## README

# @ capgo/ 电容器- pdf- 生成器

在您的 Capacitor app 中创建 HTML 字符串或网页中的 PDF 文件, 然后以 Base64 返回, 或者打开共享工作表 。 Cordova pdf-生成器插件的现代端口.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-pdf-generator)](https://capgo.app/?ref=plugin_pdf_generator)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_pdf_generator)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_pdf_generator) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-pdf-generator` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _添加@capgo/capor-pdf-生成器到我的 Capacitor app上并把它接上_ [代理设置指南](https://capgo.app/agents/?ref=plugin_pdf_generator) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_pdf_generator)

![@capgo/capacitor-pdf-generator for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-pdf-generator/main/assets/github-social-preview.png)

## 主要特点

-   **从 HTML**数字 : `fromData()` 将 HTML 字符串变成 PDF .
-   **从 URL 中**数字 : `fromURL()` 将远程页面转换为 PDF .
-   **产出**获取 `base64` 数据或以文件名打开本地共享对话框.
-   **版式**: A3或A4页在肖像或地貌上.
-   **平台**: iOS和Android. 互联网档案馆的存檔,存档日期2013-12-22. 在每个平台上以本地WebView进行渲染. 在网上不可用.

从 HTML 字符串或远程 URL 生成 PDF 文件 .

科多瓦港 [pdf 生成器](https://github.com/feedhenry-staff/pdf-generator) 具有现代化本地执行的 Capacitor 插件 .

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/pdf-生成器/](https://capgo.app/docs/plugins/pdf-generator/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-pdf-generator` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-pdf-generator
npx cap sync
```

## 使用量

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

const result = await PdfGenerator.fromData({
  data: '<html><body><h1>Hello Capgo</h1></body></html>',
  documentSize: 'A4',
  orientation: 'portrait',
  type: 'base64',
  fileName: 'example.pdf',
});

if (result.type === 'base64') {
  console.log(result.base64);
}
```

## API 密码

-   [`fromURL(...)`](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-fromurl)
-   [`fromData(...)`](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-fromdata)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-type-aliases)

### 从URL (...)

```typescript
fromURL(options: PdfGeneratorFromUrlOptions) => Promise<PdfGeneratorResult>
```

从提供的 URL 生成 PDF .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PdfGeneratorFromUrlOptions](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-pdfgeneratorfromurloptions)` |

**回返情况:** `Promise<[PdfGeneratorResult](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-pdfgeneratorresult)>`

* * *

### 从 Data (...)

```typescript
fromData(options: PdfGeneratorFromDataOptions) => Promise<PdfGeneratorResult>
```

从原始的 HTML 字符串生成 PDF .

| 参数 | 类型 |
| --- | --- |
| **`options`** | `[PdfGeneratorFromDataOptions](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-pdfgeneratorfromdataoptions)` |

**回返情况:** `Promise<[PdfGeneratorResult](https://npmcn.com/package/%40capgo/capacitor-pdf-generator/#readme-pdfgeneratorresult)>`

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

获取本地 Capacitor 插件版本

**回返情况:** `Promise<{ version: string; }>`

* * *

### 接口

#### PdfGenerator 从Url 选项

| Prop | 类型 |
| --- | --- |
| **`url`** | `string` |

#### PdfGenerator 从数据选项

| Prop | 类型 | 说明 |
| --- | --- | --- |
| **`data`** | `string` | 要渲染的 HTML 文档. |
| **`baseUrl`** | `string` | 在解决 HTML 字符串中的相对资源时要使用的基址 。 省略时, `about:blank` 已使用. |

### 类型异名

#### PdfGenerator 结果

`{ type: 'base64'; base64: string; } | { type: 'share'; completed: boolean; }`

## 常见问题

### @capgo/capacitor-pdf-generator 是什么？

从iOS和Android上的HTML字符串或URL生成PDF文件\.

### 如何安装 @capgo/capacitor-pdf-generator？

在项目目录运行 npm install @capgo/capacitor-pdf-generator，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-pdf-generator 支持 TypeScript 吗？

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

### @capgo/capacitor-pdf-generator 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-pdf-generator 可以商用吗？

@capgo/capacitor-pdf-generator 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-pdf-generator 的下载量有多少？

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

### @capgo/capacitor-pdf-generator 还在维护吗？

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