Print.js javascript庫 實現頁面打印
官網地址
您可以從GitHub版本下載最新版本的Print.js
下載v1.0.61
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();
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 | 與targetStyle相同,這將處理任何一系列樣式。例如:['border','padding'],將包括'border-bottom','border-top','border-left','border-right','padding-top'等。你也可以傳遞['*']來處理所有樣式 |
| 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時要執(zhí)行的功能 |
| onLoadingEnd: | null | 加載PDF后要執(zhí)行的功能 |
| documentTitle: | 'Document' | 打印html,image或json時,它將顯示為文檔標題。如果用戶嘗試將打印作業(yè)保存為pdf文件,它也將是文檔的名稱。 |
| fallbackPrintable: | null | 打印pdf時,如果瀏覽器不兼容(檢查瀏覽器兼容性表),庫將在新選項卡中打開pdf。這允許您傳遞要打開的不同pdf文檔,而不是傳遞給printable的原始文檔。如果您在備用pdf文件中注入javascript,這可能很有用。 |
| onPdfOpen : | null | 打印pdf時,如果瀏覽器不兼容(檢查瀏覽器兼容性表),庫將在新選項卡中打開pdf??梢栽诖颂巶鬟f回調函數,這將在發(fā)生這種情況時執(zhí)行。在您想要處理打印流程,更新用戶界面等的某些情況下,它可能很有用。 |
| onPrintDialogClose: | null | 關閉瀏覽器打印對話框后執(zhí)行回調功能 |
| onError: | error => throw error | 發(fā)生錯誤時要執(zhí)行的回調函數。 |
| base64: | false | 在打印作為base64數據傳遞的PDF文檔時使用 |
| honorMarginPadding(不建議使用): | true | 這用于保留或刪除正在打印的元素的填充和邊距。有時這些樣式設置在屏幕上很棒,但在打印時看起來很糟糕。您可以通過將其設置為false來刪除它。 |
| honorColor(不建議使用) : | false | 要以彩色打印文本,請將此屬性設置為true。默認情況下,所有文本都將以黑色打印。 |
| font(不建議使用): | 'TimesNewRoman' | 打印HTML或JSON時使用的字體 |
| font_size(不建議使用): | '12pt' | 打印HTML或JSON時使用的字體大小 |
| imageStyle (不建議使用): | 'width:100%;' | 打印圖像時使用。接受包含要應用于每個圖像的自定義樣式的字符串。 |
| frameId: | null | print.js會將要打印的內容復制到一個新的Frame中,此參數是frame的id值 |
示例
HTML打印
有時我們只想打印HTML頁面的選定部分,這可能很棘手。使用Print.js,我們可以輕松傳遞我們要打印的元素的id。該元素可以是任何標記,只要它具有唯一ID即可。該庫將嘗試將其打印得非常接近它在屏幕上的外觀,同時,它將為它創(chuàng)建一個打印機友好的格式。
<form method="post" action="#" id="printJS-form">
...
</form>
<button type="button" onclick="printJS('printJS-form', 'html')">
Print Form
</button>
向表單添加標題
<button type="button" onclick="printJS({ printable: 'printJS-form', type: 'html', header: '這是標題內容' })">
打印
</button>
html時候需要注意的事項:
直接采用默認的參數打印html的時候如果打印內容過多時候可能會非常慢,這時候需要設置scanStyles:false,然后把css抽取出來,這樣速度就會非常的快!
printJS({ printable: 'myHtmlElement', type: 'html', scanStyles: false, css: '/my_stylesheet.css' })
圖片的打印
通過傳遞圖像網址,Print.js可用于快速打印頁面上的任何圖像。當您使用低分辨率版本的圖像在屏幕上顯示多個圖像時,此功能非常有用。當用戶嘗試打印所選圖像時,您可以將高分辨率URL傳遞給Print.js。
<img src="images/print-01.jpg" />
printJS('圖片的url', 'image')
添加標題
printJS({printable: 'images/print-01-highres.jpg', type: 'image', header: '這是標題'})
打印多張圖片
printJS({
printable: ['images/print-01-highres.jpg', 'images/print-02-highres.jpg', 'images/print-03-highres.jpg'],
type: 'image',
header: '標題僅顯示在第一張圖片',
imageStyle: 'width:50%;margin-bottom:20px;'
})
JSON的打印
一種簡單快捷的方法來打印動態(tài)數據或javascript對象數組。
var someJSONdata = [
{
name: 'John Doe',
email: 'john@doe.com',
phone: '111-111-1111'
},
{
name: 'Barry Allen',
email: 'barry@flash.com',
phone: '222-222-2222'
},
{
name: 'Cool Dude',
email: 'cool@dude.com',
phone: '333-333-3333'
}
]
<button type="button"
onclick="printJS({printable: someJSONdata, properties: ['name', 'email', 'phone'], type: 'json'})">
打印
</button>
自定義css來設置數據網格的樣式:
<button type="button" onclick="printJS({
printable: someJSONdata,
properties: ['name', 'email', 'phone'],
type: 'json',
gridHeaderStyle: 'color: red; border: 2px solid #3971A5;',
gridStyle: 'border: 2px solid #3971A5;'
})">
打印
</button>
自定義發(fā)送對象數組的表頭文本
<button type="button" onclick="printJS({
printable: someJSONdata,
properties: [
{ field: 'name', displayName: '自定義表頭'},
{ field: 'email', displayName: '自定義表頭'},
{ field: 'phone', displayName: '自定義表頭'}
],
type: 'json'
})">
打印
</button>
JSON,HTML和圖像打印可以接收原始HTML標頭
<button type="button" onclick="printJS({
printable: someJSONdata,
type: 'json',
properties: ['name', 'email', 'phone'],
header: '<h3 class="custom-h3">My custom header</h3>',
style: '.custom-h3 { color: red; }'
})">
Print header raw html
</button>
感謝WwJoyous的分享
浪客行1213的簡書

xhh