---
description: Capacitor plugin for seamless printing on Android and iOS. Supports base64, files, HTML, PDFs, and web views.
title: Printer Plugin for Capacitor - Capawesome
image: https://capawesome.io/docs/assets/images/social/plugins/printer.png
---

[ Skip to content](#capawesome-teamcapacitor-printer) 

[ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) 

* [  Formbricks ](/docs/plugins/formbricks/)
* [  Geocoder ](/docs/plugins/geocoder/)
* [  Google Sign-In ](/docs/plugins/google-sign-in/)
* [  libSQL ](/docs/plugins/libsql/)
* [  Live Update ](/docs/plugins/live-update/)
* [  Managed Configurations ](/docs/plugins/managed-configurations/)
* [  Media Session ](/docs/plugins/media-session/)
* [  ML Kit ](/docs/plugins/mlkit/)
* [  NFC ](/docs/plugins/nfc/)
* [  OAuth ](/docs/plugins/oauth/)
* [  Pedometer ](/docs/plugins/pedometer/)
* [  Photo Editor ](/docs/plugins/photo-editor/)
* [  PostHog ](/docs/plugins/posthog/)
* Printer [  Printer ](/docs/plugins/printer/)
* [  Configuration ](#configuration)
* [  Usage ](#usage)
* [  API ](#api)
* [  Type Aliases ](#type-aliases)
* [  Changelog ](#changelog)
* [  Breaking Changes ](#breaking-changes)
* [  License ](#license)
* [  Purchases ](/docs/plugins/purchases/)
* [  RealtimeKit ](/docs/plugins/realtimekit/)
* [  Screen Orientation ](/docs/plugins/screen-orientation/)
* [  Screenshot ](/docs/plugins/screenshot/)
* [  Secure Preferences ](/docs/plugins/secure-preferences/)
* [  Speech Recognition ](/docs/plugins/speech-recognition/)
* [  Speech Synthesis ](/docs/plugins/speech-synthesis/)
* [  Share Target ](/docs/plugins/share-target/)
* [  Square Mobile Payments ](/docs/plugins/square-mobile-payments/)
* [  SQLite ](/docs/plugins/sqlite/)
* [  Superwall ](/docs/plugins/superwall/)
* [  Torch ](/docs/plugins/torch/)
* [  Wifi ](/docs/plugins/wifi/)
* [  Zip ](/docs/plugins/zip/)
* [  Cloud ](/docs/cloud/)
* [  Live Updates ](/docs/cloud/live-updates/)
* Advanced
* Integrations
* [  Native Builds ](/docs/cloud/native-builds/)
* [  Configuration ](/docs/cloud/native-builds/configuration/)
* [  Environments ](/docs/cloud/native-builds/environments/)
* Guides
* [  Sample Projects ](/docs/cloud/native-builds/sample-projects/)
* [  Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [  Automations ](/docs/cloud/automations/)
* Account
* Organizations
* [  Organization and User Management ](/docs/cloud/organizations/memberships/)
* [  Single Sign-On (SSO) ](/docs/cloud/organizations/sso/)
* [  Teams ](/docs/cloud/organizations/teams/)
* [  Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/)
* [  Integrations ](/docs/cloud/integrations/)
* [  License Keys ](/docs/cloud/license-keys/)
* [  Webhooks ](/docs/cloud/webhooks/)
* [  Pricing ](https://capawesome.io/pricing/)
* [  FAQ ](/docs/cloud/faq/)
* [  Support ](/docs/cloud/support/)
* [  Contributing ](/docs/contributing/)
* [  LLMs ](/docs/llms/)
* [  Insiders ](/docs/insiders/)
* [  License ](https://capawesome.io/legal/eula/)
* [  Support ](/docs/insiders/support/)
* [  FAQ ](/docs/insiders/faq/)
* [  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 <YOUR_LICENSE_KEY>
`

**Attention**: Replace `<YOUR_LICENSE_KEY>` 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: '<h1>Hello World</h1>',
[](#%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<void>
`

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<void>
`

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<void>
`

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<void>
`

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<void>
`

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 7, 2026 

 Back to top