Getting Started

Copiez un prompt de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.

        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.

Installation

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil d'IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à la plateforme ci-dessous :

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

Importer

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

API Présentation

`fromURL`

Génère un PDF à partir de l'URL fournie.

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

const result = await PdfGenerator.fromURL({ url: 'https://example.com' });
console.log(result);

`fromData`

Génère un PDF à partir d'une chaîne HTML brute.

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

const result = await PdfGenerator.fromData({ data: 'data' });
console.log(result);

Référence de type

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

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.tsRexécuter à nouveau la synchronisation lorsque le public API change en amont.

Continuez de là pour Commencer

Si vous utilisez Getting Started pour planifier le stockage et la gestion des fichiers, connectez-l’à Utiliser @capgo/capacitor-pdf-generator pour la capacité native dans Utiliser @capgo/capacitor-pdf-generator, @capgo/capacitor-stockage-de-données-sqlite pour le détail d'implémentation dans @capgo/capacitor-data-storage-sqlite, Utiliser @capgo/capacitor-data-storage-sqlite pour la capacité native dans Utiliser @capgo/capacitor-data-storage-sqlite, /capgo/capacitor-fichier pour les détails d'implémentation dans le fichier @capgo/capacitor-file, et En utilisant le fichier @capgo/capacitor-file pour la capacité native dans l'utilisation du fichier @capgo/capacitor-file.