---
description: Capacitor plugin to generate paginated PDF files from HTML content or a URL, with selectable page sizes and orientation. Supports Android and iOS.
title: Capacitor PDF Generator Plugin - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/pdf-generator.png
---
[Skip to content ](#capacitor-pdf-generator-plugin)
[🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/)
* [ SDKs ](/docs/sdks/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ Gyroscope ](/docs/sdks/capacitor/gyroscope/)
* [ Haptics ](/docs/sdks/capacitor/haptics/)
* [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/)
* [ Install Referrer ](/docs/sdks/capacitor/install-referrer/)
* [ Keep Awake ](/docs/sdks/capacitor/keep-awake/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Localization ](/docs/sdks/capacitor/localization/)
* [ Mail Composer ](/docs/sdks/capacitor/mail-composer/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ Network ](/docs/sdks/capacitor/network/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* [ Node.js ](/docs/sdks/capacitor/nodejs/)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Passkeys ](/docs/sdks/capacitor/passkeys/)
* [ Password Autofill ](/docs/sdks/capacitor/password-autofill/)
* PDF Generator [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/)
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ PixLive ](/docs/sdks/capacitor/pixlive/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Root Detection ](/docs/sdks/capacitor/root-detection/)
* [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screen Reader ](/docs/sdks/capacitor/screen-reader/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/)
* [ Shake ](/docs/sdks/capacitor/shake/)
* [ Silent Mode ](/docs/sdks/capacitor/silent-mode/)
* [ SIM ](/docs/sdks/capacitor/sim/)
* [ SMS Composer ](/docs/sdks/capacitor/sms-composer/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ Text Zoom ](/docs/sdks/capacitor/text-zoom/)
* [ Thermal State ](/docs/sdks/capacitor/thermal-state/)
* [ Toast ](/docs/sdks/capacitor/toast/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Volume ](/docs/sdks/capacitor/volume/)
* [ Wallet ](/docs/sdks/capacitor/wallet/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories
* [ Configuration ](#configuration)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Changelog ](#changelog)
* [ License ](#license)
# Capacitor PDF Generator Plugin[¶](#capacitor-pdf-generator-plugin "Permanent link")
Capacitor plugin to generate paginated PDF files from HTML content or URLs.
[  ](https://cloud.capawesome.io/)
## Features[¶](#features "Permanent link")
* 📄 **HTML to PDF**: Generate PDF files from HTML strings, for example invoices, tickets, and reports.
* 🌐 **URL to PDF**: Generate PDF files from web pages.
* 📃 **Pagination**: Real page breaks with selectable page sizes (A3, A4, A5, Letter) and orientation.
* 🖋️ **Vector Output**: Text stays selectable and sharp at any zoom level.
* 📂 **File Output**: Results are written to a file so even large documents don't exhaust memory.
* ⏱️ **Timeout**: Configurable timeout so hung pages never hang your app.
* 🤝 **Compatibility**: Works alongside the [PDF Viewer](https://capawesome.io/docs/sdks/capacitor/pdf-viewer/), [Printer](https://capawesome.io/docs/sdks/capacitor/printer/) and [File Opener](https://capawesome.io/docs/sdks/capacitor/file-opener/) plugins.
* 🔒 **App Store safe**: Uses only official platform APIs.
* 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.
* 🔁 **Up-to-date**: Always supports the latest Capacitor version.
Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!
## Newsletter[¶](#newsletter "Permanent link")
Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/).
## Compatibility[¶](#compatibility "Permanent link")
| Plugin Version | Capacitor Version | Status |
| -------------- | ----------------- | -------------- |
| 0.x.x | \>=8.x.x | Active support |
## Installation[¶](#installation "Permanent link")
You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:
`[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins
`
Then use the following prompt:
`` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/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:
`[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-pdf-generator
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
### Android[¶](#android "Permanent link")
On Android, this plugin renders the HTML content in a hidden WebView and creates the PDF file with the [Android Print Framework](https://developer.android.com/training/printing). No additional configuration is required.
### iOS[¶](#ios "Permanent link")
On iOS, this plugin renders the HTML content in a hidden WKWebView and creates the PDF file with [UIKit](https://developer.apple.com/documentation/uikit). No additional configuration is required.
### Web[¶](#web "Permanent link")
This plugin is not available on the web. Use `window.print()` with [print CSS](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS%5Fmedia%5Fqueries/Printing) to let the user save a web page as a PDF file.
## Configuration[¶](#configuration "Permanent link")
No configuration required for this plugin.
## Usage[¶](#usage "Permanent link")
The generated PDF file is written to the cache directory and deleted on the next app launch. Move it to a permanent location if you want to keep it, for example with the `rename(...)` method of the [Filesystem](https://capacitorjs.com/docs/apis/filesystem) plugin. You can also hand the path to the [PDF Viewer](https://capawesome.io/docs/sdks/capacitor/pdf-viewer/), [Printer](https://capawesome.io/docs/sdks/capacitor/printer/), [File Opener](https://capawesome.io/docs/sdks/capacitor/file-opener/) or [Share](https://capacitorjs.com/docs/apis/share) plugin.
`[](#%5F%5Fcodelineno-3-1)import { PdfGenerator, Orientation, PageSize } from '@capawesome/capacitor-pdf-generator';
[](#%5F%5Fcodelineno-3-2)
[](#%5F%5Fcodelineno-3-3)const generateFromHtml = async () => {
[](#%5F%5Fcodelineno-3-4) const { path } = await PdfGenerator.generateFromHtml({
[](#%5F%5Fcodelineno-3-5) html: 'Invoice
Thank you for your purchase!
',
[](#%5F%5Fcodelineno-3-6) fileName: 'invoice.pdf',
[](#%5F%5Fcodelineno-3-7) pageSize: PageSize.A4,
[](#%5F%5Fcodelineno-3-8) orientation: Orientation.Portrait,
[](#%5F%5Fcodelineno-3-9) });
[](#%5F%5Fcodelineno-3-10) return path;
[](#%5F%5Fcodelineno-3-11)};
[](#%5F%5Fcodelineno-3-12)
[](#%5F%5Fcodelineno-3-13)const generateFromUrl = async () => {
[](#%5F%5Fcodelineno-3-14) const { path } = await PdfGenerator.generateFromUrl({
[](#%5F%5Fcodelineno-3-15) url: 'https://capawesome.io/',
[](#%5F%5Fcodelineno-3-16) pageSize: PageSize.Letter,
[](#%5F%5Fcodelineno-3-17) orientation: Orientation.Landscape,
[](#%5F%5Fcodelineno-3-18) timeout: 10000,
[](#%5F%5Fcodelineno-3-19) });
[](#%5F%5Fcodelineno-3-20) return path;
[](#%5F%5Fcodelineno-3-21)};
`
## API[¶](#api "Permanent link")
* [generateFromHtml(...)](#generatefromhtml)
* [generateFromUrl(...)](#generatefromurl)
* [Interfaces](#interfaces)
* [Enums](#enums)
### generateFromHtml(...)[¶](#generatefromhtml "Permanent link")
`[](#%5F%5Fcodelineno-4-1)generateFromHtml(options: GenerateFromHtmlOptions) => Promise
`
Generate a paginated PDF file from an HTML string.
Only available on Android and iOS.
| Param | Type |
| ----------- | --------------------------------------------------- |
| **options** | [GenerateFromHtmlOptions](#generatefromhtmloptions) |
**Returns:** `Promise<[GenerateResult](#generateresult)>`
**Since:** 0.1.0
---
### generateFromUrl(...)[¶](#generatefromurl "Permanent link")
`[](#%5F%5Fcodelineno-5-1)generateFromUrl(options: GenerateFromUrlOptions) => Promise
`
Generate a paginated PDF file from a URL.
Only available on Android and iOS.
| Param | Type |
| ----------- | ------------------------------------------------- |
| **options** | [GenerateFromUrlOptions](#generatefromurloptions) |
**Returns:** `Promise<[GenerateResult](#generateresult)>`
**Since:** 0.1.0
---
### Interfaces[¶](#interfaces "Permanent link")
#### GenerateResult[¶](#generateresult "Permanent link")
| Prop | Type | Description | Since |
| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **path** | string | The path of the generated PDF file. The file is stored in the cache directory and deleted on the next app launch. Move it to a permanent location if you want to keep it. | 0.1.0 |
#### GenerateFromHtmlOptions[¶](#generatefromhtmloptions "Permanent link")
| Prop | Type | Description | Default | Since |
| --------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | ----- |
| **baseUrl** | string | The base URL to resolve relative resources (e.g. images, stylesheets) in the HTML content against. | | 0.1.0 |
| **fileName** | string | The name of the generated PDF file. If the name does not end with .pdf, the extension is appended. | A randomly generated file name. | 0.1.0 |
| **html** | string | The HTML content to generate the PDF file from. | | 0.1.0 |
| **orientation** | [Orientation](#orientation) | The page orientation of the generated PDF file. | Orientation.Portrait | 0.1.0 |
| **pageSize** | [PageSize](#pagesize) | The page size of the generated PDF file. | PageSize.A4 | 0.1.0 |
| **timeout** | number | The maximum time in milliseconds to wait for the PDF generation to complete before the call is rejected with the TIMEOUT error code. | 30000 | 0.1.0 |
#### GenerateFromUrlOptions[¶](#generatefromurloptions "Permanent link")
| Prop | Type | Description | Default | Since |
| --------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | ----- |
| **fileName** | string | The name of the generated PDF file. If the name does not end with .pdf, the extension is appended. | A randomly generated file name. | 0.1.0 |
| **orientation** | [Orientation](#orientation) | The page orientation of the generated PDF file. | Orientation.Portrait | 0.1.0 |
| **pageSize** | [PageSize](#pagesize) | The page size of the generated PDF file. | PageSize.A4 | 0.1.0 |
| **timeout** | number | The maximum time in milliseconds to wait for the PDF generation to complete before the call is rejected with the TIMEOUT error code. | 30000 | 0.1.0 |
| **url** | string | The URL of the web page to generate the PDF file from. | | 0.1.0 |
### Enums[¶](#enums "Permanent link")
#### Orientation[¶](#orientation "Permanent link")
| Members | Value | Description | Since |
| ------------- | ----------- | ---------------------- | ----- |
| **Landscape** | 'LANDSCAPE' | Landscape orientation. | 0.1.0 |
| **Portrait** | 'PORTRAIT' | Portrait orientation. | 0.1.0 |
#### PageSize[¶](#pagesize "Permanent link")
| Members | Value | Description | Since |
| ---------- | -------- | ------------------------ | ----- |
| **A3** | 'A3' | ISO A3 (297 x 420 mm). | 0.1.0 |
| **A4** | 'A4' | ISO A4 (210 x 297 mm). | 0.1.0 |
| **A5** | 'A5' | ISO A5 (148 x 210 mm). | 0.1.0 |
| **Letter** | 'LETTER' | US Letter (8.5 x 11 in). | 0.1.0 |
## Changelog[¶](#changelog "Permanent link")
See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/pdf-generator/CHANGELOG.md).
## License[¶](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/pdf-generator/LICENSE).
July 7, 2026
Back to top
```json
{"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/#article", "headline": "Capacitor PDF Generator Plugin", "name": "Capacitor PDF Generator Plugin", "description": "Capacitor plugin to generate paginated PDF files from HTML content or a URL, with selectable page sizes and orientation. Supports Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/#software", "name": "Capacitor PDF Generator Plugin", "description": "Capacitor plugin to generate paginated PDF files from HTML content or a URL, with selectable page sizes and orientation. Supports Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/pdf-generator/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]}
```