开始入门

复制一个包含安装步骤和本插件完整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 Manual Setup，安装插件并运行以下命令，然后遵循以下平台特定的说明：

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

导入

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

API概述

`fromURL`

从提供的URL生成PDF。

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

await PdfGenerator.fromURL({} as PdfGeneratorFromUrlOptions);

`fromData`

从原始HTML字符串生成PDF。

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

await PdfGenerator.fromData({} as PdfGeneratorFromDataOptions);

类型参考

`PdfGeneratorFromUrlOptions`

export interface PdfGeneratorFromUrlOptions extends PdfGeneratorCommonOptions {
  url: string;
}

`PdfGeneratorResult`

export type PdfGeneratorResult =
  | {
      type: 'base64';
      base64: string;
    }
  | {
      type: 'share';
      completed: boolean;
    };

`PdfGeneratorFromDataOptions`

export 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 来规划存储和文件处理，连接它到使用@capgo/capacitor-pdf-generator 为native capability在使用@capgo/capacitor-pdf-generator, @capgo/capacitor-data-storage-sqlite 为implementation detail在@capgo/capacitor-data-storage-sqlite, 使用@capgo/capacitor-data-storage-sqlite 为native capability在使用@capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file 为implementation detail在@capgo/capacitor-file,和使用 @capgo/capacitor-file 为使用 @capgo/capacitor-file 中的本地能力