Project Awesome project awesome
♥

capacitor-pdf-generator

Generate PDF files from HTML strings or URLs on iOS and Android.

Package 6 stars GitHub

@capgo/capacitor-pdf-generator

Capgo - Instant updates for capacitor

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 version Capacitor compatibility Maintained
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

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.

Param Type
options PdfGeneratorFromUrlOptions

Returns: Promise<PdfGeneratorResult>

fromData(...)

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

Generates a PDF from a raw HTML string.

Param Type
options PdfGeneratorFromDataOptions

Returns: Promise<PdfGeneratorResult>

getPluginVersion()

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

Get the native Capacitor plugin version

Returns: Promise<{ version: string; }>

Interfaces

PdfGeneratorFromUrlOptions

Prop Type
url string

PdfGeneratorFromDataOptions

Prop Type Description
data string HTML document to render.
baseUrl string Base 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; }

Back to Ionic Framework