Plugin for the Cordova framework to print HTML from iOS, Android and Windows Universal apps.
AirPrint is an Apple™ technology that helps you create full-quality printed output without the need to download or install drivers. AirPrint is built in to many printer models from most popular printer manufacturers. Just select an AirPrint printer on your local network to print from your favorite iOS or OS X app.
See Drawing and Printing Guide for iOS for detailed informations.
Starting with KitKat, most Android devices have print service plugins installed to enable printing using the Google Cloud Print and Google Drive services. Print service plugins from other printer manufactures are available through the App Store though the Google Cloud Print service plugin can also be used to print from an Android device to just about any printer type and model.
In addition to supporting physical printers, it is also possible to save printed output to your Google Drive account or locally as a PDF file on the Android device.
See Building Apps with Multimedia for Android for detailed informations.
- iOS 8 or newer
- Android KitKat or newer
- Universal Windows Platform
Install the latest version:
cordova plugin add cordova-plugin-printer
Or a specific version:
cordova plugin add cordova-plugin-printer@VERSION
Or the latest dev version:
cordova plugin add https://github.com/katzer/cordova-plugin-printer.git
Or a custom version:
cordova plugin add cordova-plugin-printer --searchpath path/to/plugin
And then execute:
cordova build
- Fix broken check and pick on Android N and above
- Fixed incompatibility with Android KitKat (4.4)
Known limitations
- Plugin crashes on Windows OS 10.0.14
- check on Android might return empty result as some versions of cordova seems to have a bug with multipart results.
See CHANGELOG.md to get the full changelog for the plugin.
The plugin and its methods are not available before the deviceready event has been fired.
document.addEventListener('deviceready', function () {
// cordova.plugins.printer is now available
}, false);The device his printing capabilities can be reviewed through the printer.check interface. Use this function to hide print functionality from users who will be unable to use it.
/**
* Checks if the printer service is available (iOS)
* or if printer services are installed and enabled (Android).
*
* @param {Function} callback
* A callback function
* @param {Object} scope
* Optional scope of the callback
* Defaults to: window
*/
cordova.plugins.printer.check(function (available, count) {
alert(available ? 'Found ' + count + ' services' : 'No');
});Displays a system interface allowing the user to select an available printer.
To speak with a printer directly you need to know the network address by picking them before via printer.pick.
Note that picking a printer is not supported for windows platform.
/**
* Displays system interface for selecting a printer.
*
* @param {Function} callback
* A callback function
*/
cordova.plugins.printer.pick(function (uri) {
alert(uri ? uri : 'Canceled');
});Content can be send to a printer through the printer.print interface. The method takes a string with HTML content, an URI pointing to another web page or any DOM node.
/**
* Sends the content to print service.
*
* @param {String} content
* HTML string or DOM node
* if latter, innerHTML is used to get the content
* @param {Object} options
* Options for the print job
* @param {Function} callback
* An optional callback function
* @param {Object} scope
* An optional scope of the callback
* Defaults to: window
*/
cordova.plugins.printer.print('<html>..</html>', { duplex: 'long' }, function (res) {
alert(res ? 'Done' : 'Canceled');
});The method accepts a list of attributes. Not all are supported on each platform and by each printer!
| Name | Description | Type | Platform |
|---|---|---|---|
| name | The name of the print job and of the document | String | all |
| duplex | Specifies the duplex mode to use for the print job. Either double-sided on short site (duplex:'short'), double-sided on long site (duplex:'long') or single-sided (duplex:'none'). Defaults to: 'none' |
String | all |
| landscape | The orientation of the printed content, portrait or landscape. Defaults to: false |
Boolean | all |
| graystyle | If your application only prints black text, setting this property to true can result in better performance in many cases. Defaults to: false |
Boolean | all |
| printerId | The network URL to the printer. | String | iOS |
| border | Set to false to skip any border. Useful for fullscreen images. Defaults to: true |
Boolean | iOS |
| hidePageRange | Set to true to hide the control for the page range. Defaults to: false |
Boolean | iOS |
| hideNumberOfCopies | Set to true to hide the control for the number of copies. Defaults to: false |
Boolean | iOS |
| hidePaperFormat | Set to true to hide the control for the paper format. Defaults to: false |
Boolean | iOS |
| paperWidth | Ability to hint width of the paper – iOS will get a printer supported paperformat which fits the best to this width. Only works when paperHeight is given. Width in millimeters. |
Number | iOS |
| paperHeight | Ability to hint height of the paper – iOS will get a printer paperformat which fits the best to this heigth. Only works when paperWidth is given. Height in millimeters. |
Number | iOS |
| paperCutLength | On roll-fed printers you can decide after how many milimeters the printer cuts the paper. | Number | iOS |
| bounds | The Size and position of the print view Defaults to: [40, 30, 0, 0] |
Array | iPad |
- All CSS rules needs to be embedded or accessible via absolute URLs in order to print out HTML encoded content.
- The string can contain HTML content or an URI pointing to another web page.
NOTE: All CSS rules needs to be embedded or accessible via absolute URLs in order to print out HTML encoded content.
Print the whole HTML page:
var page = location.href;
cordova.plugins.printer.print(page, 'Document.html');Print the content from one part of the page:
var page = document.getElementById('legal-notice');
cordova.plugins.printer.print(page, 'Document.html');Print some custom content:
var page = '<h1>Hello Document</h1>';
cordova.plugins.printer.print(page, 'Document.html');Print a remote web page:
cordova.plugins.printer.print('http://blackberry.de', 'BB10');Send to printer directly:
cordova.plugins.printer.pick(function (uri) {
cordova.plugins.printer.print(page, { printerId: uri });
});- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
This software is released under the Apache 2.0 License.
Made with 😋 from Leipzig
© 2016 appPlant GmbH