electron-pos-pdf
v1.4.3
Published
Electron POS PDF generator
Downloads
1
Maintainers
Readme
Electron-pos-pdf
An electron printer plugin, currently supports 58mm, requires electron >= 6.x.x.
Installation
$ npm install electron-pos-pdf
$ yarn add electron-pos-pdf
Demo
Check out this Demo by fssonca
Usage
In main process
const {PosPrinter} = require("electron-pos-pdf");
In render process
const {PosPrinter} = require('electron').remote.require("electron-pos-pdf");
const {PosPrinter} = require("electron-pos-pdf");
const path = require("path");
const options = {
preview: false, // Preview in window or print
width: '170px', // width of content body
margin: '0 0 0 0', // margin of content body
copies: 1, // Number of copies to print
printerName: 'XP-80C', // printerName: string, check with webContent.getPrinters()
timeOutPerLine: 400,
pageSize: { height: 301000, width: 71000 } // page size
}
const data = [
{
type: 'image',
url: 'https://randomuser.me/api/portraits/men/43.jpg', // file path
position: 'center', // position of image: 'left' | 'center' | 'right'
width: '160px', // width of image in px; default: auto
height: '60px', // width of image in px; default: 50 or '50px'
},{
type: 'text', // 'text' | 'barCode' | 'qrCode' | 'image' | 'table
value: 'SAMPLE HEADING',
style: {fontWeight: "700", textAlign: 'center', fontSize: "24px"}
},{
type: 'text', // 'text' | 'barCode' | 'qrCode' | 'image' | 'table'
value: 'Secondary text',
style: {textDecoration: "underline", fontSize: "10px", textAlign: "center", color: "red"}
},{
type: 'barCode',
value: '023456789010',
height: 40, // height of barcode, applicable only to bar and QR codes
width: 2, // width of barcode, applicable only to bar and QR codes
displayValue: true, // Display value below barcode
fontsize: 12,
},{
type: 'qrCode',
value: 'https://github.com/Hubertformin/electron-pos-pdf',
height: 55,
width: 55,
style: { margin: '10 20px 20 20px' }
},{
type: 'table',
// style the table
style: {border: '1px solid #ddd'},
// list of the columns to be rendered in the table header
tableHeader: ['Animal', 'Age'],
// multi dimensional array depicting the rows and columns of the table body
tableBody: [
['Cat', 2],
['Dog', 4],
['Horse', 12],
['Pig', 4],
],
// list of columns to be rendered in the table footer
tableFooter: ['Animal', 'Age'],
// custom style for the table header
tableHeaderStyle: { backgroundColor: '#000', color: 'white'},
// custom style for the table body
tableBodyStyle: {'border': '0.5px solid #ddd'},
// custom style for the table footer
tableFooterStyle: {backgroundColor: '#000', color: 'white'},
},{
type: 'table',
style: {border: '1px solid #ddd'}, // style the table
// list of the columns to be rendered in the table header
tableHeader: [{type: 'text', value: 'People'}, {type: 'image', path: path.join(__dirname, 'icons/animal.png')}],
// multi-dimensional array depicting the rows and columns of the table body
tableBody: [
[{type: 'text', value: 'Marcus'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/43.jpg'}],
[{type: 'text', value: 'Boris'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/41.jpg'}],
[{type: 'text', value: 'Andrew'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/23.jpg'}],
[{type: 'text', value: 'Tyresse'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/53.jpg'}],
],
// list of columns to be rendered in the table footer
tableFooter: [{type: 'text', value: 'People'}, 'Image'],
// custom style for the table header
tableHeaderStyle: { backgroundColor: 'red', color: 'white'},
// custom style for the table body
tableBodyStyle: {'border': '0.5px solid #ddd'},
// custom style for the table footer
tableFooterStyle: {backgroundColor: '#000', color: 'white'},
},
]
PosPrinter.getPdfBuffer(data, options)
.then(console.log)
.catch((error) => {
console.error(error);
});
Typescript
Usage
import {PosPrinter, PosPrintData, PosPrintOptions} from "electron-pos-pdf";
import * as path from "path";
const options: PosPrintOptions = {
preview: false,
width: '170px',
margin: '0 0 0 0',
copies: 1,
printerName: 'XP-80C',
timeOutPerLine: 400,
pageSize: { height: 301000, width: 71000 } // page size
}
const data: PosPrintData[] = [
{
type: 'image',
url: 'https://randomuser.me/api/portraits/men/43.jpg', // file path
position: 'center', // position of image: 'left' | 'center' | 'right'
width: '160px', // width of image in px; default: auto
height: '60px', // width of image in px; default: 50 or '50px'
},{
type: 'text', // 'text' | 'barCode' | 'qrCode' | 'image' | 'table
value: 'SAMPLE HEADING',
style: {fontWeight: "700", textAlign: 'center', fontSize: "24px"}
},{
type: 'text', // 'text' | 'barCode' | 'qrCode' | 'image' | 'table'
value: 'Secondary text',
style: {textDecoration: "underline", fontSize: "10px", textAlign: "center", color: "red"}
},{
type: 'barCode',
value: '023456789010',
height: 40, // height of barcode, applicable only to bar and QR codes
width: 2, // width of barcode, applicable only to bar and QR codes
displayValue: true, // Display value below barcode
fontsize: 12,
},{
type: 'qrCode',
value: 'https://github.com/Hubertformin/electron-pos-pdf',
height: 55,
width: 55,
style: { margin: '10 20px 20 20px' }
},{
type: 'table',
// style the table
style: {border: '1px solid #ddd'},
// list of the columns to be rendered in the table header
tableHeader: ['Animal', 'Age'],
// multi dimensional array depicting the rows and columns of the table body
tableBody: [
['Cat', 2],
['Dog', 4],
['Horse', 12],
['Pig', 4],
],
// list of columns to be rendered in the table footer
tableFooter: ['Animal', 'Age'],
// custom style for the table header
tableHeaderStyle: { backgroundColor: '#000', color: 'white'},
// custom style for the table body
tableBodyStyle: {'border': '0.5px solid #ddd'},
// custom style for the table footer
tableFooterStyle: {backgroundColor: '#000', color: 'white'},
},{
type: 'table',
style: {border: '1px solid #ddd'}, // style the table
// list of the columns to be rendered in the table header
tableHeader: [{type: 'text', value: 'People'}, {type: 'image', path: path.join(__dirname, 'icons/animal.png')}],
// multi-dimensional array depicting the rows and columns of the table body
tableBody: [
[{type: 'text', value: 'Marcus'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/43.jpg'}],
[{type: 'text', value: 'Boris'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/41.jpg'}],
[{type: 'text', value: 'Andrew'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/23.jpg'}],
[{type: 'text', value: 'Tyresse'}, {type: 'image', url: 'https://randomuser.me/api/portraits/men/53.jpg'}],
],
// list of columns to be rendered in the table footer
tableFooter: [{type: 'text', value: 'People'}, 'Image'],
// custom style for the table header
tableHeaderStyle: { backgroundColor: 'red', color: 'white'},
// custom style for the table body
tableBodyStyle: {'border': '0.5px solid #ddd'},
// custom style for the table footer
tableFooterStyle: {backgroundColor: '#000', color: 'white'},
},
]
PosPrinter.getPdfBuffer(data, options)
.then(console.log)
.catch((error) => {
console.error(error);
});
Printing options
| Options | Required | Description |
|----------------|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| printerName | No | (string) the printer's name. If not set, the systems default printer will be used. |
| copies | No | (number) number of copies to print |
| preview | No | (boolean) preview in a window, default is false |
| width | No | (string) width of a page |
| margin | No | (string) margin of a page, css values can be used |
| timeOutPerLine | No | (number) timeout per line, default is 200 |
| silent | No | (boolean) To print silently without printer selection pop-up, default is true |
| pageSize | No | (SizeOptions) Specify the width and height of the print out page |
| pathTemplate | No | (string) Path to custom html template. Can be used for custom print styles. |
| header | No | (string) string to be printed as page header. |
| footer | No | (string) string to be printed as page footer. |
| margins | No | (object) Page margins. See electron docs |
| landscape | No | (boolean) Whether the page should be printed in landscape mode. Default is false
. |
| scaleFactor | No | (number) The scale factor of the web page. |
| pagesPerSheet | No | (number) The number of pages to print per page sheet. |
| collate | No | (boolean) Whether the page should be collated. |
| pageRanges | No | (object[]) The page range to print. See electron docs |
| duplexMode | No | (string) Set the duplex mode of the printed web page. See electron docs |
| pageSize | No | (string or object) Specify page size of the printed document. Can be A3, A4, A5, Legal, Letter, Tabloid or an Object containing height and width. See electron docs |
| dpi | No | (object) See electron docs |
Important
The
css
property is no longer supported, instead use style. Example:style: {fontWeight: "700", textAlign: 'center', fontSize: "24px"}
The Print data object
| | |
|------------------|:----------------------------------------------------------------------------------------------------------------|
| type | (string) 'text', 'qrCode', 'barCode', 'image', 'table' // type 'text' can be an html string |
| value | (string) value of the current row |
| height | (number) applicable to type barCode and qrCode |
| width | (number) applicable to type barCode and qrCode |
| style | (PrintDataStyle) add css styles to line (jsx syntax) ex: {fontSize: 12, backgroundColor: '#2196f3}
|
| displayValue | (boolean) display value of barcode below barcode |
| position | (string) 'left', 'center', 'right' applicable to types qrCode and image |
| path | (string) Path or url to the image asset |
| url | (string) Url to image or a base 64 encoding of image |
| tableHeader | (PosPrintTableField[], string[]) the columns to be rendered in the header of the table, works with type table |
| tableBody | (PosPrintTableField[][], string[][]) the columns to be rendered in the body of the table, works with type table |
| tableFooter | (PosPrintTableField[], string[]) the columns to rendered it the footer of the table, works with type table |
| tableHeaderStyle | (string) set custom style to the table header |
| tableBodyStyle | (string) set custom style to the table body |
| tableFooterStyle | (string) set custom style to the table footer |
Author
- Alfian Lensun
- [email protected]
Fork from
- Hubert Formin
- [email protected]
- Twitter: @hformin