Getting Started

インストール手順とフルマークダウンガイドを含むセットアップの質問をコピーします。

        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.

インストール

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`

__CAPGO_KEEP_0__を元のHTML文字列から生成します。

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

await PdfGenerator.fromData({} as PdfGeneratorFromDataOptions);

__CAPGO_KEEP_2__

`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;
}

__CAPGO_KEEP_7__

このページはプラグインから生成されています。 src/definitions.ts再度、パブリック API がアップストリームで変更された場合に、sync を再実行してください。

Getting Started から続けてください。

Capacitor を使用している場合 Getting Started を使用して、ストレージとファイルのハンドリングを計画するには、Capacitor を接続してください。 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-pdf-generator を使用して、Native Capability を使用する場合 @capgo/capacitor-pdf-generator を使用する場合の実装詳細については、@capgo/capacitor-data-storage-sqlite を参照してください。 @capgo/capacitor-data-storage-sqlite を使用して、@capgo/capacitor-data-storage-sqlite の実装詳細を参照してください。 @capgo/capacitor-data-storage-sqlite を使用して、ストレージとファイルのハンドリングを計画するには、Capacitor を接続してください。 @capgo/capacitor-data-storage-sqlite を使用して、ストレージとファイルのハンドリングを計画するには、Capacitor を接続してください。 @capgo/capacitor-data-storage-sqlite を使用して、ストレージとファイルのハンドリングを計画するには、Capacitor を接続してください。本地機能の使用 (@capgo/capacitor-data-storage-sqlite) について @capgo/capacitor-file 実装詳細 (@capgo/capacitor-file) について本地機能の使用 (@capgo/capacitor-file) について for the native capability in Using @capgo/capacitor-file.