Getting Started

GitHub

Einen Setup-Befehl mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin erstellen.

        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.

Installieren

Sie können unser AI-gestütztes Setup verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool mit folgendem Befehl hinzu:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Dann verwenden Sie die folgende Anweisung:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die untenstehenden plattform-spezifischen Anweisungen befolgen:

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

Importieren

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

API Übersicht

`fromURL`

Erstellt ein PDF aus der bereitgestellten URL.

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

await PdfGenerator.fromURL({} as PdfGeneratorFromUrlOptions);

`fromData`

Erstellt ein PDF aus einem Roh-HTML-String.

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

await PdfGenerator.fromData({} as PdfGeneratorFromDataOptions);

Typenreferenz

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

Quelle der Wahrheit

Diese Seite wird aus dem Plugin generiert. src/definitions.tsRe-run die Synchronisierung, wenn die öffentliche API upstream ändert.

Weitermachen von Getting Started

Wenn Sie Getting Started zur Planung von Speicher und Dateimanagement verwenden, verbinden Sie es mit Mit @capgo/capacitor-pdf-generator für die native Fähigkeit in Mit @capgo/capacitor-pdf-generator, Mit @capgo/capacitor-data-storage-sqlite für die Implementierungsdetails in @capgo/capacitor-data-storage-sqlite, Mit @capgo/capacitor-data-storage-sqlite für die native Fähigkeit in Mit @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file für die Implementierungsdetails in @capgo/capacitor-file, und Mit @capgo/capacitor-file für die native Fähigkeit in Mit @capgo/capacitor-file.