Generate PDF files from HTML strings or remote URLs.
Port of the Cordova pdf-generator plugin for Capacitor with a modernized native implementation.
The most complete doc is available here: https://capgo.app/docs/plugins/pdf-generator/
npm install @capgo/capacitor-pdf-generator
npx cap syncimport { 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);
}fromURL(options: PdfGeneratorFromUrlOptions) => Promise<PdfGeneratorResult>Generates a PDF from the provided URL.
| Param | Type |
|---|---|
options |
PdfGeneratorFromUrlOptions |
Returns: Promise<PdfGeneratorResult>
fromData(options: PdfGeneratorFromDataOptions) => Promise<PdfGeneratorResult>Generates a PDF from a raw HTML string.
| Param | Type |
|---|---|
options |
PdfGeneratorFromDataOptions |
Returns: Promise<PdfGeneratorResult>
getPluginVersion() => Promise<{ version: string; }>Get the native Capacitor plugin version
Returns: Promise<{ version: string; }>
| Prop | Type |
|---|---|
url |
string |
| 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: 'base64'; base64: string; } | { type: 'share'; completed: boolean; }