Prise en main

Copier un prompt de configuration avec les étapes d'installation et la guide markdown complet 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.

Installer

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

Importer

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

API Vue d'ensemble

`fromURL`

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

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

await PdfGenerator.fromURL({} as PdfGeneratorFromUrlOptions);

`fromData`

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

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

await PdfGenerator.fromData({} as PdfGeneratorFromDataOptions);

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.tsRe-run la synchronisation lorsque le public API change en amont.

Continuez de l'étape de démarrage

Si vous utilisez Getting Started pour planifier le stockage et la gestion des fichiers, connectez-le à Utilisez @capgo/capacitor-pdf-generator pour la capacité native dans Utilisez @capgo/capacitor-pdf-generator, @capgo/capacitor-data-storage-sqlite pour le détail d'implémentation dans @capgo/capacitor-data-storage-sqlite, Utilisez @capgo/capacitor-data-storage-sqlite pour la capacité native dans Utilisez @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file pour le détail d'implémentation dans @capgo/capacitor-file, et Utiliser @capgo/capacitor-fichier pour la capacité native dans Utiliser @capgo/capacitor-fichier.