@dimer47/capacitor-plugin-printer

v2.0.2

Published

16 days ago

Capacitor plugin for printing HTML, PDF, images and plain text on iOS and Android

0High
0Medium
0Low

dimer47

capacitor plugin native printer print pdf html ios android

🖨️ Capacitor Plugin Printer

Version Last update Bundle size Repo size Downloads License

A Capacitor plugin to print HTML, PDF, images, and plain text on iOS, Android, and Web.

import { Printer } from '@dimer47/capacitor-plugin-printer';

await Printer.printHtml({ html: '<b>Hello Capacitor!</b>' });

⚠️ Warning: Version 2.0 introduces breaking changes (migration from Cordova to Capacitor 8, new dedicated print methods, Swift + Kotlin rewrite). If you were using version 1.x, please review the new API below.

🎉 Features

📄 Print HTML & CSS with full styling support
📝 Print plain text with font customization
📑 Print PDF documents from file paths or URIs
🖼️ Print images (PNG, JPEG, GIF, BMP, HEIF)
🔐 Print base64-encoded data with explicit MIME types
🌐 Print the current WebView content
📐 Paper sizes — named sizes (A0–A10, Letter, Legal, Tabloid, etc.) and custom dimensions
📏 Unit support — points, inches, millimeters, centimeters
🎨 Headers & footers with labels, page numbers, and font styling (iOS)
🖨️ Direct print to a specific printer without dialog (iOS)
✂️ Duplex printing (double-sided)

📍 Supported Platforms

| Platform | Version | |:---------|:--------| | iOS | 15+ | | Android | 7.0+ (API 24) | | Web | Modern browsers |

📦 Installation

npm install @dimer47/capacitor-plugin-printer
npx cap sync

🧮 API

Methods

| Method | Description | |:-------|:-----------| | print() | Print content with auto-detected type | | printHtml() | Print an HTML string | | printPdf() | Print a PDF from a file path or URI | | printBase64() | Print base64-encoded data | | printFile() | Print a file from a path or URI | | printWebView() | Print the current WebView content | | canPrintItem() | Check if the device can print | | getPrintableTypes() | List supported printable document types | | pick() | Show the printer picker (iOS only) |

📄 print()

print(options?: PrintOptions) => Promise<PrintResult>

Print content with automatic type detection. The plugin detects whether the content is HTML, a file URI, base64 data, or plain text.

// HTML
await Printer.print({ content: '<h1>Hello</h1>' });

// File
await Printer.print({ content: 'file:///path/to/document.pdf' });

// Base64
await Printer.print({ content: 'base64://JVBERi0...' });

// Plain text
await Printer.print({ content: 'Hello World' });

📄 printHtml()

printHtml(options: PrintHtmlOptions) => Promise<PrintResult>

Print an HTML string.

await Printer.printHtml({
  html: '<h1>Invoice</h1><p>Amount: $42.00</p>',
  name: 'Invoice',
  orientation: 'portrait',
});

📑 printPdf()

printPdf(options: PrintPdfOptions) => Promise<PrintResult>

Print a PDF file from a path or URI.

await Printer.printPdf({ path: 'file:///path/to/document.pdf' });

🔐 printBase64()

printBase64(options: PrintBase64Options) => Promise<PrintResult>

Print base64-encoded data with an explicit MIME type.

await Printer.printBase64({
  data: 'JVBERi0xLjQK...', // base64 string without prefix
  mimeType: 'application/pdf',
});

🖼️ printFile()

printFile(options: PrintFileOptions) => Promise<PrintResult>

Print a file from a path or URI. The MIME type is detected automatically if not provided.

await Printer.printFile({ path: 'file:///path/to/image.png' });

// With explicit MIME type
await Printer.printFile({
  path: 'file:///path/to/doc',
  mimeType: 'application/pdf',
});

🌐 printWebView()

printWebView(options?: PrintWebViewOptions) => Promise<PrintResult>

Print the current WebView content.

await Printer.printWebView();

// With options
await Printer.printWebView({ orientation: 'landscape' });

✅ canPrintItem()

canPrintItem(options?: CanPrintOptions) => Promise<CanPrintResult>

Check if the device supports printing, optionally for a specific item.

const { available } = await Printer.canPrintItem();

// Check a specific URI
const { available } = await Printer.canPrintItem({ uri: 'file:///path/to/file.pdf' });

📋 getPrintableTypes()

getPrintableTypes() => Promise<PrintableTypesResult>

Get the list of printable document types supported by the platform (UTIs on iOS, MIME types on Android).

const { types } = await Printer.getPrintableTypes();
// e.g. ["com.adobe.pdf", "public.jpeg", "public.png", ...]

🖨️ pick()

pick(options?: PickOptions) => Promise<PickResult>

Show the system printer picker. iOS only — on Android, this method will reject.

const { url } = await Printer.pick();
if (url) {
  await Printer.printHtml({ html: '<p>Direct print</p>', printer: url });
}

⚙️ Options

BasePrintOptions

Common options shared by all print methods.

| Property | Type | Default | Platform | Description | |:---------|:-----|:--------|:---------|:------------| | name | string | — | All | Job name and document title | | orientation | 'portrait' \| 'landscape' | 'portrait' | All | Print orientation | | monochrome | boolean | false | All | Black & white printing | | photo | boolean | false | iOS | Photography media type for higher quality | | copies | number | 1 | iOS | Number of copies | | pageCount | number | — | iOS, Android | Maximum number of pages to print | | duplex | 'none' \| 'long' \| 'short' | 'none' | All | Double-sided printing | | margin | boolean \| MarginOptions | — | All | Margins. Set to false to disable | | font | FontOptions | — | iOS | Font configuration for plain text | | maxWidth | string \| number | — | iOS | Maximum content width | | maxHeight | string \| number | — | iOS | Maximum content height | | header | HeaderFooterOptions | — | iOS | Header configuration | | footer | HeaderFooterOptions | — | iOS | Footer configuration | | paper | PaperOptions | — | iOS, Android | Paper format | | printer | string | — | iOS | Printer URL for direct printing (skip dialog) | | ui | UIOptions | — | iOS | Printer dialog UI options | | autoFit | boolean | true | Android | Auto-scale images to fit content area | | javascript | boolean | false | Android | Enable JavaScript in WebView rendering |