--- description: Capacitor plugin for seamless printing on Android and iOS. Supports base64, files, HTML, PDFs, and web views. title: Capacitor Printer Plugin for Android, iOS & Web - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/printer.png --- [ Skip to content](#capawesome-teamcapacitor-printer) [ 🔐 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/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * Printer [ Printer ](/docs/sdks/capacitor/printer/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Type Aliases ](#type-aliases) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ 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/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ 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 or Yarn ](/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) * [ Type Aliases ](#type-aliases) * [ Changelog ](#changelog) * [ Breaking Changes ](#breaking-changes) * [ License ](#license) # @capawesome-team/capacitor-printer[¶](#capawesome-teamcapacitor-printer "Permanent link") Capacitor plugin for seamless printing on Android and iOS. Supports base64, files, HTML, PDFs, and web views. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[¶](#features "Permanent link") We are proud to offer one of the most complete and feature-rich Capacitor plugins for printing. Here are some of the key features: * 🖥️ **Cross-platform**: Supports Android, iOS and Web. * 🖨️ **Base64 Printer**: Print base64 encoded files. * 🖨️ **File Printer**: Print files from the device. * 🖨️ **HTML Printer**: Print custom HTML content. * 🖨️ **PDF Printer**: Print PDF files. * 🖨️ **Web View Printer**: Print web view content. * ⚔️ **Battle-Tested**: Used in more than 100 projects. * 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * 🔁 **Up-to-date**: Always supports the latest Capacitor version. * ⭐️ **Support**: Priority support from the Capawesome Team. * ✨ **Handcrafted**: Built from the ground up with care and expertise, not forked or AI-generated. 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 | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | ## Demo[¶](#demo "Permanent link") A working example can be found [here](https://github.com/robingenz/capacitor-plugin-demo). | Android | iOS | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | ![Android Demo](../../../assets/external/github.com/capawesome-team/capacitor-plugins/assets/13857929/7de4bcb3-aa59-43bc-a882-2796964be539.gif) | ![iOS Demo](../../../assets/external/github.com/capawesome-team/capacitor-plugins/assets/13857929/d796d9f0-32c1-4d5c-b38f-ab46509a5eda.gif) | ## Guides[¶](#guides "Permanent link") * [Exploring the Capacitor Printer API](https://capawesome.io/blog/exploring-the-capacitor-printer-api/) ## Installation[¶](#installation "Permanent link") This plugin is only available to [Capawesome Insiders](https://capawesome.io/insiders/). First, make sure you have the Capawesome npm registry set up. You can do this by running the following commands: `[](#%5F%5Fcodelineno-0-1)npm config set @capawesome-team:registry https://npm.registry.capawesome.io [](#%5F%5Fcodelineno-0-2)npm config set //npm.registry.capawesome.io/:_authToken ` **Attention**: Replace `` with the license key you received from Polar. If you don't have a license key yet, you can get one by becoming a [Capawesome Insider](https://capawesome.io/insiders/). Next, 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-1-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-2-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome-team/capacitor-printer` 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-3-1)npm install @capawesome-team/capacitor-printer [](#%5F%5Fcodelineno-3-2)npx cap sync ` ### Android[¶](#android "Permanent link") #### Proguard[¶](#proguard "Permanent link") If you are using Proguard, you need to add the following rules to your `proguard-rules.pro` file: `[](#%5F%5Fcodelineno-4-1)-keep class io.capawesome.capacitorjs.plugins.** { *; } ` #### Variables[¶](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$androidxDocumentFileVersion` version of `androidx.documentfile:documentfile` (default: `1.1.0`) * `$androidxPrintVersion` version of `androidx.print:print` (default: `1.1.0`) This can be useful if you encounter dependency conflicts with other plugins in your project. ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-5-1)import { Printer } from '@capawesome-team/capacitor-printer'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const printBase64 = async () => { [](#%5F%5Fcodelineno-5-4) await Printer.printBase64({ [](#%5F%5Fcodelineno-5-5) name: 'My Document', [](#%5F%5Fcodelineno-5-6) data: 'JVBERi0...', [](#%5F%5Fcodelineno-5-7) }); [](#%5F%5Fcodelineno-5-8)} [](#%5F%5Fcodelineno-5-9) [](#%5F%5Fcodelineno-5-10)const printFile = async () => { [](#%5F%5Fcodelineno-5-11) await Printer.printFile({ [](#%5F%5Fcodelineno-5-12) mimeType: 'application/pdf', [](#%5F%5Fcodelineno-5-13) path: 'content://com.android.providers.downloads.documents/document/msf%3A1000000485', [](#%5F%5Fcodelineno-5-14) }); [](#%5F%5Fcodelineno-5-15)}; [](#%5F%5Fcodelineno-5-16) [](#%5F%5Fcodelineno-5-17)const printHtml = async () => { [](#%5F%5Fcodelineno-5-18) await Printer.printHtml({ [](#%5F%5Fcodelineno-5-19) name: 'My Document', [](#%5F%5Fcodelineno-5-20) html: '

Hello World

', [](#%5F%5Fcodelineno-5-21) }); [](#%5F%5Fcodelineno-5-22)}; [](#%5F%5Fcodelineno-5-23) [](#%5F%5Fcodelineno-5-24)const printPdf = async () => { [](#%5F%5Fcodelineno-5-25) await Printer.printPdf({ [](#%5F%5Fcodelineno-5-26) name: 'My Document', [](#%5F%5Fcodelineno-5-27) path: 'content://com.android.providers.downloads.documents/document/msf%3A1000000485', [](#%5F%5Fcodelineno-5-28) }); [](#%5F%5Fcodelineno-5-29)}; [](#%5F%5Fcodelineno-5-30) [](#%5F%5Fcodelineno-5-31)const printWebView = async () => { [](#%5F%5Fcodelineno-5-32) await Printer.printWebView({ [](#%5F%5Fcodelineno-5-33) name: 'My Document', [](#%5F%5Fcodelineno-5-34) }); [](#%5F%5Fcodelineno-5-35)}; ` ## API[¶](#api "Permanent link") * [printBase64(...)](#printbase64) * [printFile(...)](#printfile) * [printHtml(...)](#printhtml) * [printPdf(...)](#printpdf) * [printWebView(...)](#printwebview) * [Interfaces](#interfaces) * [Type Aliases](#type-aliases) ### printBase64(...)[¶](#printbase64 "Permanent link") `[](#%5F%5Fcodelineno-6-1)printBase64(options: PrintBase64Options) => Promise ` Present the printing user interface to print files encoded as base64 strings. **Attention**: Large files can lead to app crashes. It's therefore recommended to use the `printFile` method instead. Only available on Android and iOS. | Param | Type | | ----------- | ----------------------------------------- | | **options** | [PrintBase64Options](#printbase64options) | **Since:** 7.1.0 --- ### printFile(...)[¶](#printfile "Permanent link") `[](#%5F%5Fcodelineno-7-1)printFile(options: PrintFileOptions) => Promise ` Present the printing user interface to print files. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------- | | **options** | [PrintFileOptions](#printfileoptions) | **Since:** 7.1.0 --- ### printHtml(...)[¶](#printhtml "Permanent link") `[](#%5F%5Fcodelineno-8-1)printHtml(options: PrintHtmlOptions) => Promise ` Present the printing user interface to print a html document. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------- | | **options** | [PrintHtmlOptions](#printhtmloptions) | **Since:** 5.0.0 --- ### printPdf(...)[¶](#printpdf "Permanent link") `[](#%5F%5Fcodelineno-9-1)printPdf(options: PrintPdfOptions) => Promise ` Present the printing user interface to print a pdf document. Only available on Android and iOS. | Param | Type | | ----------- | ----------------------------------- | | **options** | [PrintPdfOptions](#printpdfoptions) | **Since:** 5.1.0 --- ### printWebView(...)[¶](#printwebview "Permanent link") `[](#%5F%5Fcodelineno-10-1)printWebView(options?: PrintOptions | undefined) => Promise ` Present the printing user interface to print the web view content. You can use a print style sheet to customize the print output (see https://developer.mozilla.org/en-US/docs/Web/CSS/CSS\_media\_queries/Printing). | Param | Type | | ----------- | ----------------------------- | | **options** | [PrintOptions](#printoptions) | **Since:** 5.0.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### PrintBase64Options[¶](#printbase64options "Permanent link") | Prop | Type | Description | Since | | ------------ | ------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **data** | string | A valid base 64 encoded string. | 7.1.0 | | **mimeType** | string | The mime type of the data. The following mime types are supported: application/pdf, image/gif, image/heic, image/heif, image/jpeg, image/png. | 7.1.0 | #### PrintFileOptions[¶](#printfileoptions "Permanent link") | Prop | Type | Description | Since | | ------------ | ------ | ----------------------------------------------------- | ----- | | **mimeType** | string | The mime type of the file. Only available on Android. | 7.1.0 | | **path** | string | The path to the file. | 7.1.0 | #### PrintHtmlOptions[¶](#printhtmloptions "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | -------------------------- | ----- | | **html** | string | The HTML content to print. | 5.0.0 | #### PrintPdfOptions[¶](#printpdfoptions "Permanent link") | Prop | Type | Description | Since | | -------- | ------ | ------------------------------------------- | ----- | | **path** | string | The path to the pdf document on the device. | 5.1.0 | #### PrintOptions[¶](#printoptions "Permanent link") | Prop | Type | Description | Default | Since | | -------- | ------ | -------------------------- | ---------- | ----- | | **name** | string | The name of the print job. | 'Document' | 5.0.0 | ### Type Aliases[¶](#type-aliases "Permanent link") #### PrintWebViewOptions[¶](#printwebviewoptions "Permanent link") `[PrintOptions](#printoptions)` ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/printer/CHANGELOG.md). ## Breaking Changes[¶](#breaking-changes "Permanent link") See [BREAKING.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/printer/BREAKING.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/printer/LICENSE). May 17, 2026 Back to top