Getting Started

GitHub

Eine Einrichtungsvoreinstellung mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin kopieren.

        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 unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten zu Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Verwenden Sie dann die folgende Anfrage:

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

If Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und folgen Sie den Plattform-spezifischen Anweisungen unten:

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

Einfügen

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 einer Roh-HTML-Zeichenfolge.

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

await PdfGenerator.fromData({} as PdfGeneratorFromDataOptions);

Typenverweis

`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

This page is generated from the plugin’s src/definitions.tsRe-run the Sync, wenn die öffentliche API upstream ändert.

Fortsetzung von Getting Started

Wenn Sie Storage und Dateimanagement planen, verbinden Sie es mit Getting Started um Storage und Dateimanagement zu planen, verbinden Sie es mit Using @capgo/capacitor-pdf-generator Using @capgo/capacitor-pdf-generator für die native Fähigkeit in Using @capgo/capacitor-pdf-generator, @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite für die Implementierungsdetail in @capgo/capacitor-data-storage-sqlite, Using @capgo/capacitor-data-storage-sqlite für die native Fähigkeit in @capgo/capacitor-data-storage-sqlite @capgo/capacitor-file für die Implementierungsdetail in @capgo/capacitor-file, und Mit @capgo/capacitor-file für die native Fähigkeit in Mit @capgo/capacitor-file.