官网地址:https://printjs./
您可以从GitHub版本下载最新版本的Print.js:https://github.com/crabbly/Print.js/releases
npm 安装
npm install print-js --save
npm安装时将库导入项目
import print from 'print-js'
首先,我们需要在页面上包含Print.js库和样式
<script src="print.js"></script> <link rel="stylesheet" type="text/css" href="print.css">
下面主要介绍一下我们要用的打印方法printJS();将接受一个对象作为参数,下面表格的参数则为该对象的属性,通过控制属性值来控制打印:
参数 | 默认值 | 说明 |
---|---|---|
printable: | null | 文档来源:pdf或图像的url,html元素的id或json数据的对象 |
type: | 可打印类型。可用的打印选项包括:pdf,html,image,json和raw-html。 | |
header: | null | 用于HTML,Image或JSON打印的可选标头。它将放在页面顶部。此属性将接受文本或原始HTML |
headerStyle: | 'font-weight:300;' | 要应用于标题文本的可选标题样式 |
maxWidth: | 800 | 最大文档宽度(像素)。根据需要更改此项。在打印HTML,图像或JSON时使用。 |
css: | null | 这允许我们传递一个或多个应该应用于正在打印的html的css文件URL。值可以是包含单个URL的字符串,也可以是包含多个URL的数组。 |
style: | null | 这允许我们传递一个字符串,该字符串应该应用于正在打印的html。 |
scanStyles: | true | 设置为false时,库不会处理应用于正在打印的html的样式。使用css参数时很有用。 |
targetStyle: | null | 默认情况下,在打印HTML元素时,库仅处理某些样式。此选项允许您传递要处理的样式数组。例如:['padding-top','border-bottom'] |
targetStyles: | null | 与 |
ignoreElements: | [] | 接受打印父html元素时应忽略的html的id数组。 |
properties: | null | 在打印JSON时使用。这些是对象属性名称。 |
gridHeaderStyle: | 'font-weight:bold;' | 打印JSON数据时网格标题的可选样式。 |
gridStyle: | 'border: 1px solid lightgray; margin-bottom: -1px;' | 打印JSON数据时网格行的可选样式 |
repeatTableHeader: | true | 在打印JSON数据时使用。设置为时false,数据表标题仅显示在第一页中。 |
showModal: | null | 启用此选项可在检索或处理大型PDF文件时显示用户反馈 |
modalMessage: | 'Retrieving Document...' | 当向用户显示的消息showModal被设定为true。 |
onLoadingStart: | null | 加载PDF时要执行的功能 |
onLoadingEnd: | null | 加载PDF后要执行的功能 |
documentTitle: | 'Document' | 打印html,image或json时,它将显示为文档标题。如果用户尝试将打印作业保存为pdf文件,它也将是文档的名称。 |
fallbackPrintable: | null | 打印pdf时,如果浏览器不兼容(检查浏览器兼容性表),库将在新选项卡中打开pdf。这允许您传递要打开的不同pdf文档,而不是传递给 |
onPdfOpen : | null | 打印pdf时,如果浏览器不兼容(检查浏览器兼容性表),库将在新选项卡中打开pdf。可以在此处传递回调函数,这将在发生这种情况时执行。在您想要处理打印流程,更新用户界面等的某些情况下,它可能很有用。 |
onPrintDialogClose: | null | 关闭浏览器打印对话框后执行回调功能 |
onError: | error => throw error | 发生错误时要执行的回调函数。 |
base64: | false | 在打印作为base64数据传递的PDF文档时使用 |
honorMarginPadding(不建议使用): | true | 这用于保留或删除正在打印的元素的填充和边距。有时这些样式设置在屏幕上很棒,但在打印时看起来很糟糕。您可以通过将其设置为false来删除它。 |
honorColor(不建议使用) : | false | 要以彩色打印文本,请将此属性设置为true。默认情况下,所有文本都将以黑色打印。 |
ont(不建议使用): | 'TimesNewRoman' | 打印HTML或JSON时使用的字体 |
font_size(不建议使用): | '12pt' | 打印HTML或JSON时使用的字体大小 |
imageStyle (不建议使用): | 'width:100%;' | 打印图像时使用。接受包含要应用于每个图像的自定义样式的字符串。 |
frameId: | null | print.js会将要打印的内容复制到一个新的Frame中,此参数是frame的id值 |