Getting Started

复制一个包含安装步骤和该插件的完整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.

如果您更喜欢手动设置，请通过运行以下命令安装插件，并按照以下平台特定的说明进行操作:

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

如果您正在使用 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-file的实现细节，并使用@capgo/capacitor-file 查看@capgo/capacitor-file的原生能力