vue-plugin-hiprint使用教程【1】

前言：
1、本文档适合新手
2、文档仅限于基本的使用，更深的高级应用请查阅相关资料
3、文档编写时相应功能都有测试过
4、教程文字代码有点多，CSDN无法一篇文章发布，所以拆分成若干篇
5、默默吐槽一句：CSDN无法承载太大的篇幅。所以我把教程导出为markdown文件，有需要的各位自行下载。
https://cloud.189.cn/t/FviyyijY3uyu （访问码：2gvs）

*、编写教程时的一些环境

// 编写教程时的软件环境
node：12.22.12
@vue/cli: 5.0.8
vue：3.2.36
// 参考资料
在线演示：https://ccsimple.gitee.io/vue-plugin-hiprint/
微信文档：https://mp.weixin.qq.com/mp/appmsgalbum?__biz=MzUyMzg5NDU0Mg==&action=getalbum&album_id=2779135389855956995&scene=173&subscene=&sessionid=svr_95b1d3bfd09&enterid=1703059529&from_msgid=2247484532&from_itemidx=1&count=3&nolastread=1#wechat_redirect
gitee地址：https://gitee.com/CcSimple/vue-plugin-hiprint#vuevue3-%E5%85%A8%E5%B1%80%E5%BC%95%E5%85%A5

1、安装

// 编写此文档时版本为：0.0.56
npm install vue-plugin-hiprint

2、移植print-lock.css。

1、 安装完之后，从目录node_modules/vue-plugin-hiprint/dist下将print-lock.css复制一份
2、 将复制的css文件放在index.html同级目录下。文件名称建议不要更改，保持默认：print-lock.css
3、在index中引入第二步创建的文件

3、编写基本界面和实现基本打印功能

这里仅介绍最基本的一些功能，其余功能看官方文档：

https://mp.weixin.qq.com/s?__biz=MzUyMzg5NDU0Mg==&mid=2247484604&idx=1&sn=a26f606cea93307fb533af45558c1b65&chksm=fa34eeddcd4367cbb7b28fed888d735cd6b9b26e79c2cb460021896f5c6ece2dc1ca0c5ea581&cur_album_id=2779135389654630403&scene=189#wechat_redirect

3.1、创建拖拽区域

<!--基本代码 class必须加上ep-draggable-item，用于后续ts代码识别；tid是唯一编码。其中defaultModule开头的为默认的拖拽元素--->
<template>
  <div class="component" ref="componentRef">
    <el-row>
      <el-col :span="6">
        <div class="ep-draggable-item" tid="defaultModule.barcode">
          条形码
        </div>
        <div class="ep-draggable-item" tid="defaultModule.text">
          文本
        </div>
      </el-col>
    </el-row>
  </div>
</template>

<script lang="ts" setup>
//@ts-ignore
import { hiprint, defaultElementTypeProvider } from "vue-plugin-hiprint";
import {onMounted, ref} from "vue";
const componentRef = ref();
const fullHeight = ref();
hiprint.init({
  providers: [defaultElementTypeProvider()], // 声明拖拽元素，否则无法正确识别HTML里编写的拖拽元素
});
onMounted(() => {
  buildLeftElement();// 需要再onMounted里调用，防止带有ep-draggable-item的HTML元素还未渲染完成
});
const buildLeftElement = () => {
  // @ts-ignore
  hiprint.PrintElementTypeManager.buildByHtml($(".ep-draggable-item"));// 这里就是上面的class。
};
</script>

// 完整demo代码
<template>
  <div class="component" ref="componentRef">
    <el-row>
      <el-col :span="6">
        <div class="ep-draggable-item" tid="defaultModule.barcode">
          条形码
        </div>
        <div class="ep-draggable-item" tid="defaultModule.text">
          文本
        </div>
      </el-col>
    </el-row>
  </div>
</template>
<script lang="ts" setup>
//@ts-ignore
import { hiprint, defaultElementTypeProvider } from "vue-plugin-hiprint";
import {onMounted, ref} from "vue";

const componentRef = ref();
const fullHeight = ref();


hiprint.init({
  providers: [defaultElementTypeProvider()],
});
onMounted(() => {
  buildLeftElement();
});
const buildLeftElement = () => {
  // @ts-ignore
  hiprint.PrintElementTypeManager.buildByHtml($(".ep-draggable-item"));
};

</script>
<style scoped lang="scss">

</style>

3.2、编写设计区域（包括画布区域以及配置区域）

下面的代码已经完成了最基础的拖拽设计和属性配置

<!--完整代码-->
<template>
  <div class="component" ref="componentRef">
    <el-row>
      <el-col :span="6">
        <!-- 拖拽区域 -->
        <div class="ep-draggable-item" tid="defaultModule.barcode">
          条形码
        </div>
        <div class="ep-draggable-item" tid="defaultModule.text">
          文本
        </div>
      </el-col>
      <el-col :span="12" :style="'border: 1px solid #f0f0f0; padding: 20px;max-height: '+fullHeight+'px;overflow: auto;'" >
        <!-- 画布区域 -->
        <div id="design-content"></div>
      </el-col>
      <el-col :span="6">
        <!-- 设计元素属性配置区域 -->
        <div id="design-element-option-set"></div>
      </el-col>
    </el-row>
  </div>
</template>
<script lang="ts" setup>
//@ts-ignore
import { hiprint, defaultElementTypeProvider } from "vue-plugin-hiprint";
import {onMounted, ref} from "vue";

const componentRef = ref();
const fullHeight = ref();

let  _printDesignObj:any; // 无需响应式声明

hiprint.init({
  providers: [defaultElementTypeProvider()],
});
onMounted(() => {
  fullHeight.value = componentRef.value.clientHeight;
  buildLeftElement(); // 构建拖拽元素
  buildDesigner(); // 构建画布和属性
});
const buildLeftElement = () => {
  // @ts-ignore
  hiprint.PrintElementTypeManager.buildByHtml($(".ep-draggable-item"));
};
const buildDesigner = () => {
  $("#hiprint-printTemplate").empty();
  _printDesignObj = new hiprint.PrintTemplate({
    settingContainer: "#design-element-option-set", // 设计元素属性配置区域
  });
  _printDesignObj.design("#design-content"); // 画布区域
}

</script>
<style scoped lang="scss">

</style>

3.3、尝试打印

// 在HTML中增加一个button，并将@click指向print事件
// 操作逻辑如下：从拖拽区域拖拽文本到设计区域，点击设计区域的文本元素，在右侧属性区域：基本选项卡下，将字段名称改成print函数中的name。然后click一下button，就可以看到效果

function print() {

// 打印数据，key 对应 元素的 字段名
  let printData = {name:'CcSimple'};
// 参数: 打印时设置 左偏移量，上偏移量
  let options = {leftOffset:-1,topOffset:-1}
// 扩展
  let ext = {
    callback: () => {
      console.log('浏览器打印窗口已打开')
    },
    styleHandler: () => {
      // 重写 文本 打印样式
      return'<style>.hiprint-printElement-text{color:red !important;}</style>'
    }
  }
// 调用浏览器打印
  _printDesignObj.print(printData,options,ext);
}

?