Skip to content

BarisCanYesil/capacitor-plugin-printer

Repository files navigation

Capacitor Printer Plugin


@bcyesil/capacitor-plugin-printer

Capacitor plugin for printing HTML, plain text, and images in iOS/Android apps. Supports additional features like Base64 PDF and image printing (from v0.0.5).

Printer.print({ content: '<b>Lorem ipsum...</b>'})

Versions

Capacitor Version Plugin Version
v5.x v0.0.3
v6.x v0.0.5
v7.x v0.0.6+

Supported Platforms

Plugin Version iOS Android
v0.0.5 and earlier 13+ 5.1+ (API 22)
v0.0.6+ 14+ 6.0+ (API 23)

Supported Contents

  • HTML (can use CSS inline styling)
  • Text
  • Image(as HTML)
  • Base64(PDF & image) (since v0.0.5)

Installation

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

Usage

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

.
.
.

Printer.print({ content: 'Lorem ipsum...', name: 'lorem-filename', orientation: 'landscape' })

Examples

Text:

 Printer.print({ content: 'Lorem ipsum...'})

HTML:

 Printer.print({ content: '<h1>Lorem</h1>'})

Printing multiple HTML elements:

    let contentTest: string = "";

    contentTest += '<li style="color:green">Tea</li>'
    contentTest += '<li style="font-size:50px">Coffee</li>'
    contentTest += '<img src="https://picsum.photos/200">'

    Printer.print({ content: contentTest })

Images with HTML:

 Printer.print({ content: '<img src="base64/url/path">'})

with inline CSS:

 Printer.print({ content: '<b style="color:red">Lorem ipsum</b>'})

Base64:

Important

Base64 decoder requires the "base64:" prefix for both plain Base64 values and Data URI formats.

// (since v0.0.5)
// Base64 decoder supports Plain text(just the Base64 value) & Data URI(data:content/type;base64)

 Printer.print({ content: 'base64:...'})

API

print(...)

print(printOptions: PrintOptions) => Promise<void>
Param Type
printOptions PrintOptions

Interfaces

PrintOptions

Prop Type Description Default Since
content string HTML content for print. 0.0.1
name string Name of the print of the document. iOS=YourAppName/Android=Document+CurrentTimestamp 0.0.1
orientation string Orientation of the printing page. "portrait" or "landscape" "portrait" 0.0.1

About

Capacitor plugin for printing HTML format value iOS/Android apps.

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages