Printing

Some applications e.g. event check-in may want to programatically print without going through the browser dialog.
We expose two methods to your app's window: window.todesktop.contents.getPrinters() to get the device's saved printers and window.todesktop.contents.print()  to do the actual printing.
If you have used Electron before, these methods will look familiar as we use the same function signatures.
Print the current page
window.todesktop.contents.print([options], [callback])
1
window.todesktop.contents.print(
2
  {
3
    /*
4
      Skips the browser print dialog and begins printing.
5
      Boolean. Optional. Defaults to false.
6
    */
7
    silent: true,
8
    /*
9
      Print the background color and image of the page.
10
      Boolean. Optional. Defaults to false.
11
    */
12
    printBackground: false,
13
    /*
14
      Set the printer to use. You can get the available
15
      printer names with window.todesktop.contents.getPrinters()
16
      String. Optional. Defaults to ''.
17
    */
18
    deviceName: 'EPSON_WF_7610_Series'
19
  },
20
  /*
21
    success will be a boolean indicating whether or not
22
    the printing call was successful.
23
  */
24
  success =>
25
    success
26
      ? console.log('Printed successfully.')
27
      : console.error('Could not print the page.')
28
);
Copied!
Get available printers
window.todesktop.contents.getPrinters() will return an array of available printers.
1
const printers = window.todesktop.contents.getPrinters();
2
​
3
console.log(printers[0]);
4
// {
5
//  name: 'Zebra_LP2844',
6
//  description: 'Zebra LP2844',
7
//  status: 3,
8
//  isDefault: false,
9
//  options: {
10
//    /* ... */
11
//  }
12
//}
Copied!
​

Javascript API - Previous

Navigation

Next - Javascript API

App Icon Badging, Bouncing and Progress Bar

Last modified 2yr ago

Copy link

Contents

Print the current page

Get available printers