@capgo/capacitor-pdf-generator

June 16, 2026 · View on GitHub

Capgo - Instant updates for Capacitor

➡️ Get Instant updates for your App with Capgo

Missing a feature? We’ll build the plugin for you 💪

Generate PDF files from HTML strings or remote URLs.

Port of the Cordova pdf-generator plugin for Capacitor with a modernized native implementation.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/pdf-generator/

Compatibility

Plugin versionCapacitor compatibilityMaintained
v8.*.*v8.*.*✅
v7.*.*v7.*.*On demand
v6.*.*v6.*.*❌
v5.*.*v5.*.*❌

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-pdf-generator
npx cap sync

Usage

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

const result = await PdfGenerator.fromData({
  data: '<html><body><h1>Hello Capgo</h1></body></html>',
  documentSize: 'A4',
  orientation: 'portrait',
  type: 'base64',
  fileName: 'example.pdf',
});

if (result.type === 'base64') {
  console.log(result.base64);
}

API

fromURL(...)

fromURL(options: PdfGeneratorFromUrlOptions) => Promise<PdfGeneratorResult>

Generates a PDF from the provided URL.

ParamType
optionsPdfGeneratorFromUrlOptions

Returns: Promise<PdfGeneratorResult>

fromData(...)

fromData(options: PdfGeneratorFromDataOptions) => Promise<PdfGeneratorResult>

Generates a PDF from a raw HTML string.

ParamType
optionsPdfGeneratorFromDataOptions

Returns: Promise<PdfGeneratorResult>

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version

Returns: Promise<{ version: string; }>

Interfaces

PdfGeneratorFromUrlOptions

PropType
urlstring

PdfGeneratorFromDataOptions

PropTypeDescription
datastringHTML document to render.
baseUrlstringBase URL to use when resolving relative resources inside the HTML string. When omitted, about:blank is used.

Type Aliases

PdfGeneratorResult

{ type: 'base64'; base64: string; } | { type: 'share'; completed: boolean; }