From b6f0a03058b776c18f6c3b04d4e1e26eec368983 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Katzer?= Date: Sat, 24 Aug 2013 20:28:11 +0200 Subject: [PATCH] Update README.md --- README.md | 66 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 51 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9b35572..024a083 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,12 @@ A bunch of printing plugins for Cordova 3.x.x by Sebastián Katzer ([github.com/katzer](https://github.com/katzer)) -## Supported Platforms ## +## Supported Platforms - **iOS** *(Print from iOS devices to AirPrint compatible printers)*
See [Drawing and Printing Guide for iOS](http://developer.apple.com/library/ios/documentation/2ddrawing/conceptual/drawingprintingios/Printing/Printing.html) for detailed informations and screenshots. +- **Android** *(Print through 3rd party printing apps)* -## Adding the Plugin to your project ## +## Adding the Plugin to your project Through the [Command-line Interface](http://cordova.apache.org/docs/en/3.0.0/guide_cli_index.md.html#The%20Command-line%20Interface): ```bash @@ -22,18 +23,24 @@ Through the [Command-line Interface](http://cordova.apache.org/docs/en/3.0.0/gui cordova plugin rm de.appplant.cordova.plugin.printer ``` -## Release Notes ## -#### Version 0.2.1 #### -- Support for callback scopes +## Release Notes +#### Version 0.4.0 (24.08.2013) +- [feature]: Added Android support
+ *Based on the Print Android plugin made by* ***Eion Robb*** +- [feature]: `print()` accepts a 4th arguments for platform specific properties. +- [change]: the callback of `print()` will be called with a result code about the user action. -#### Version 0.2.0 (11.08.2013) #### -- Added iOS support
+#### Version 0.2.1 (13.08.2013) +- [feature]: Support for callback scopes. + +#### Version 0.2.0 (11.08.2013) +- [feature]: Added iOS support
*Based on the Print iOS plugin made by* ***Randy McMillan*** -## Using the plugin ## +## Using the plugin The plugin creates the object ```window.plugin.printer``` with two methods: -### isServiceAvailable() ### +### isServiceAvailable() Printing is only available on devices capable of multi-tasking (iPhone 3GS, iPhone 4 etc.) running iOS 4.2 or later. You can use this function to hide print functionality from users who will be unable to use it.
Function takes a callback function, passed to which is a boolean property. Optionally you can assign the scope in which the callback will be executed as a second parameter (default to *window*). @@ -48,7 +55,20 @@ window.plugin.printer.isServiceAvailable( ); ``` -### print() ### +**Android:** The callback function will be called with a second argument which is an array, indicating which printer apps are available for printing. + +```javascript +/* + * Find out if printing is available. Use this to find out which apps are available for printing. + */ +window.plugin.printer.isServiceAvailable( + function (isAvailable, installedAppIds) { + alert('The following print apps are installed on your device: ' + installedAppIds.join(', ')); + } +); +``` + +### print() Function takes an html string and (optionally) a callback function. Optionally you can assign the scope in which the callback will be executed as a third parameter (default to *window*). ```javascript @@ -58,15 +78,31 @@ var page = document.body.innerHTML; /* * Pass an HTML and - optionally - a callback function. */ -window.plugin.printer.print(page, function (success, available, error) { - +window.plugin.printer.print(page, function (code) { + switch (code) { + case 0: // printing cancelled (cancel button pressed) + case 2: // printed + case 3: // printing failed + case 4: // page not printed (something wrong happened e.g. service is not available) + } }, this); ``` -#### Testing in the iOS Simulator #### +**Android:** An App-ID can be assigned as a platform configuration to indicate which 3rd party printing app shall be used. Otherwise the first found application will be used. + +```javascript +/* + * Pass an HTML and - optionally - a platform specific configuration. + */ +window.plugin.printer.print(page, null, this, { appId: 'epson.print' }); +``` + +## Quirks + +### Testing in the iOS Simulator There's no need to waste lots of paper when testing - if you're using the iOS simulator, select File->Open Printer Simulator to open some dummy printers (print outs will appear as PDF files). -#### Adding Page Breaks to Printouts #### +### Adding Page Breaks to Printouts Use the 'page-break-before' property to specify a page break, e.g. ```html @@ -84,7 +120,7 @@ See W3Schools for more more information: http://www.w3schools.com/cssref/pr_prin Note: you will need to add an extra top margin to new pages. -#### Printing on Real Printers #### +### Printing on Real Printers (iOS) Printing is only supported on AirPrint-enabled printers or with the use of third-party software on your computer. The following pages contain more information: - AirPrint-enabled printers: http://www.apple.com/ipad/features/airprint.html - Enabling AirPrint on your computer: http://reviews.cnet.com/8301-19512_7-20023976-233.html, or http://www.ecamm.com/mac/printopia/