开始
复制一个包含安装步骤和此插件的完整 Markdown 指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-pdf-generator`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/pdf-generator/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
安装
安装您可以使用我们的 AI 助手设置来安装插件。将 Capgo 技能添加到您的 AI 工具中,使用以下命令:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-pdf-generator` plugin in my project.如果您prefer手动设置,安装插件并运行以下命令并遵循以下平台特定说明:
bun add @capgo/capacitor-pdf-generatorbunx cap sync导入
导入import { PdfGenerator } from '@capgo/capacitor-pdf-generator';API概述
API概述fromURL
从URL从提供的URL生成PDF。
import { PdfGenerator } from '@capgo/capacitor-pdf-generator';
const result = await PdfGenerator.fromURL({ url: 'https://example.com' });console.log(result);fromData
从URL从原始HTML字符串生成PDF。
import { PdfGenerator } from '@capgo/capacitor-pdf-generator';
const result = await PdfGenerator.fromData({ data: 'data' });console.log(result);类型参考
类型参考PdfGeneratorFromUrlOptions
类型参考:PdfGeneratorFromUrlOptionsexport interface PdfGeneratorFromUrlOptions extends PdfGeneratorCommonOptions { url: string;}PdfGeneratorResult
类型参考:PdfGeneratorResultexport type PdfGeneratorResult = | { type: 'base64'; base64: string; } | { type: 'share'; completed: boolean; };PdfGeneratorFromDataOptions
类型参考:PdfGeneratorFromDataOptionsexport interface PdfGeneratorFromDataOptions extends PdfGeneratorCommonOptions { /** * HTML document to render. */ data: string; /** * Base URL to use when resolving relative resources inside the HTML string. * When omitted, `about:blank` is used. */ baseUrl?: string;}真实数据来源
真实数据来源本页面是根据插件的 src/definitions.ts重新同步公共API时,重新运行上游的同步。
继续从 Getting Started
标题:继续从 Getting Started如果您正在使用 开始使用 来规划存储和文件处理,连接它到 使用 @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 文件中的实现细节 使用 @capgo/capacitor 文件 为在使用 @capgo/capacitor 文件中的原生能力