如何在 Vue 3 中使用 vue3-print-nb 实现灵活的前端打印

安装

当前示例以Vue3+ElementPlus为例，如果要使用vue2版本的就安装npm install vue-print-nb --save

import { createApp } from 'vue'

import ElementPlus from 'element-plus'

import 'element-plus/dist/index.css'

import print from 'vue3-print-nb'

import './style.css'

import App from './App.vue'

const app = createApp(App)

app.use(ElementPlus)

app.use(print)

app.mount('#app')

使用

<script setup>

import { ref } from 'vue'

defineProps({ msg: String, })

const count = ref(0)

const tableData = [ { date: '2016-05-03', name: 'Tom', address: 'No. 189, Grove St, Los Angeles', }, { date: '2016-05-02', name: 'Tom', address: 'No. 189, Grove St, Los Angeles', }, { date: '2016-05-04', name: 'Tom', address: 'No. 189, Grove St, Los Angeles', }, { date: '2016-05-01', name: 'Tom', address: 'No. 189, Grove St, Los Angeles', }, ]

</script>

<template> <h1>{{ msg }}</h1>

<div class="btn">

<el-button type="primary" v-print="'#printTable'">打印</el-button>

</div>

<el-table id="printTable" :data="tableData" border style="width: 100%">

<el-table-column prop="date" label="Date" width="180" />

<el-table-column prop="name" label="Name" width="180" />

<el-table-column prop="address" label="Address" />

</el-table>

</template>

只需要在要打印的元素上通过v-print属性即可实现打印的效果，可以选择打印全部或者打印指定页面，比如我只想要打印el-table表格部分，只需要在el-button按钮上面绑定v-print="'#printTable'"，我已经提前在el-table上定义好了id="printTable"，v-print的属性值对应的就是el-table。 打印效果预览👇

以上实现了一个最基本的打印效果，v-print还支持更多的属性呢!它的属性值可以是一个对象以此来实现更加定制化的打印效果，一起来看看吧💖 HTML

我们可以给要打印的页面指定额外的样式、额外的样式、额外头，甚至是添加回调函数！

<div class="btn">

  <el-button type="primary" v-print="printObj">打印</el-button>

</div>

<el-table id="printTable" :data="tableData" border style="width: 100%">

 <el-table-column prop="date" label="Date" width="180" />

 <el-table-column prop="name" label="Name" width="180" />

 <el-table-column prop="address" label="Address" />

</el-table>

const printObj = { id: 'printTable',

popTitle: 'print nb',

extraCss:"https://cdn.bootcdn.net/ajax/libs/animate.css/4.1.1/animate.compat.css, https://cdn.bootcdn.net/ajax/libs/hover.css/2.3.1/css/hover-min.css",

extraHead: '<meta http-equiv="Content-Language"content="zh-cn"/>',

beforeOpenCallback (vue) {

console.log('打开之前') },

openCallback (vue) { 

console.log('执行了打印') },

 closeCallback (vue) {

console.log('关闭了打印工具')

}

}

打印网址

为printObj对象添加一个url属性即可实现打印当前网址对应的整个页面。但是如何设置了url数据就不能再同时设置id属性了。还有一点需要的注意的是设置url属性需要确保同源策略相同！

<div class="btn">

  <el-button type="primary" v-print="printObj">打印</el-button>

</div>

<el-table id="printTable" :data="tableData" border style="width: 100%">

 <el-table-column prop="date" label="Date" width="180" />

 <el-table-column prop="name" label="Name" width="180" />

 <el-table-column prop="address" label="Address" />

</el-table>

const printObj = {

url: 'http://localhost:5173/',

popTitle: 'print nb',

extraCss:"https://cdn.bootcdn.net/ajax/libs/animate.css/4.1.1/animate.compat.css, https://cdn.bootcdn.net/ajax/libs/hover.css/2.3.1/css/hover-min.css",

extraHead: '<meta http-equiv="Content-Language"content="zh-cn"/>',

beforeOpenCallback (vue) {

console.log('打开之前') },

openCallback (vue) { 

console.log('执行了打印') },

 closeCallback (vue)

{ console.log('关闭了打印工具')

}

}

2.2. 打印预览

设置了preview属性将在打印时候显示打印预览。

const printObj = {

id: 'printTable',

preview:true, // 打印预览 previewTitle: '打印预览', popTitle: 'good print', extraCss:"https://cdn.bootcdn.net/ajax/libs/animate.css/4.1.1/animate.compat.css, https://cdn.bootcdn.net/ajax/libs/hover.css/2.3.1/css/hover-min.css",

extraHead: '<meta http-equiv="Content-Language"content="zh-cn"/>',

beforeOpenCallback (vue) {

console.log('打开之前') },

openCallback (vue) {

console.log('执行了打印') },

closeCallback (vue) {

console.log('关闭了打印工具')

}

}

打印预览效果

v-print API

参数	说明	类型	可选项	默认值
id	范围打印ID，必填值	String	—	—
standard	文档类型（仅打印本地范围）	String	html5/loose/strict	html5
extraHead	在节点中添加 DOM 节点，多个节点用 分隔,（仅打印局部范围）	String	—	—
extraCss	新的 CSS 样式表，并使用 分隔多个节点,（仅打印局部范围）	String	—	-
popTitle	标签内容（仅打印本地范围）	String	—	-
openCallback	调用打印工具成功回调函数	Function	Returns the instance of Vue called at that time	-
closeCallback	关闭打印工具成功回调函数	Function	Returns the instance of Vue called at that time	-
beforeOpenCallback	调用打印工具前的回调函数	Function	Returns the instance of Vue called at that time	-
url	打印指定URL。（不可同时设置ID）	string	-	-
asyncUrl	通过 'resolve()' 返回 URL	Function	-	-
preview	预览工具	Boolean	-	false
previewTitle	预览工具标题	String	-	'打印预览'
previewPrintBtnLabel	预览工具按钮的名称	String	-	'打印'
zIndex	预览工具的 CSS：z-index	String,Number	-	20002
previewBeforeOpenCallback	启动预览工具前的回调函数	Function	Returns the instance of Vue	-
previewOpenCallback	预览工具完全打开后的回调函数	Function	Returns the instance of Vue	-

官方文档：github.com/Power-kxLee…