vg-print 1.1.303 → 1.1.305

package/README.en.md

@@ -32,6 +32,20 @@ https://download.csdn.net/download/github_38400706/92538739
 ```bash
 npm i vg-print
 ```
+If you need client direct printing (`hiwebSocket`), install the optional dependency in your host app:
+
+```bash
+npm i socket.io-client
+```
+
+In your main entry file (e.g., `main.ts`):
+
+```js
+import { io } from 'socket.io-client'
+import { setSocketIo } from 'vg-print'
+
+setSocketIo(io)
+```
 
 ## Header Component
 
@@ -365,11 +379,8 @@ createApp(App).use(vgPrint).mount('#app')
 - `preView()` Open preview
 - `printView()` Browser print
 - `print()` Direct print
-- `toPdf()` Export PDF
-- `toPdf2()` Export PDF with paper layout
-- `toImage()` Export Image
-- `toImage2()` Export Image with paper layout
-- `toImage()` Export Image
+- `toPdf()` Export PDF with the `@zumer/snapdom` pipeline, including paper layout options
+- `toImage()` Export image with the `@zumer/snapdom` pipeline, including paper layout options
 - `setHiwebSocket(host, token, cb)` Set client address/token (Respects autoConnect state)
 - `setHost(host, token, cb)` Set client address/token and connect immediately (Standard API)
 - `connect(cb)` Connect to client
@@ -431,10 +442,8 @@ exportPdf(tpl, printData, 'filename')
 `exportPdf` / `exportImage` are lightweight wrappers around the template instance methods:
 
 - `exportPdf(tpl, data, filename, options)` → `tpl.toPdf(data, filename, options)`
-- `exportPdf2(tpl, data, filename, options)` → `tpl.toPdf2(data, filename, options)`
 
 - `exportImage(tpl, data, options)` → `tpl.toImage(data, options)`
-- `exportImage2(tpl, data, options)` → `tpl.toImage2(data, options)`
 
 #### Export PDF
 

package/README.md

@@ -106,6 +106,26 @@ hiprint.register({
 npm i vg-print
 ```
 
+### 可选依赖：直连打印/客户端连接（socket.io-client）
+
+- 本库默认不内置 `socket.io-client`，以减少默认安装体积。
+- 仅当你需要“直连打印/客户端连接（hiwebSocket）”能力（如 `print()` / `print2()` / 自动连接）时，才需要安装并注入：
+
+```bash
+npm i socket.io-client
+```
+
+在项目入口（如 `main.ts`）注入：
+
+```js
+import { io } from 'socket.io-client'
+import { setSocketIo } from 'vg-print'
+
+setSocketIo(io)
+```
+
+也可直接使用 `window.io = io`（等价）。
+
 ## Header 顶部工具栏组件
 
 - 用于页面一级头部区域，内置常用操作按钮与打印机设置；支持通过 `props` 与 `slots` 定制。
@@ -635,10 +655,8 @@ const disableAutoConnect = () => designer.value.disAutoConnect()
 - `preView()` 打开预览弹窗；将当前模板与数据渲染为预览 HTML
 - `printView()` 浏览器打印；不依赖客户端，调起系统打印对话框
 - `print()` 直接打印；需客户端已连接，按当前选定打印机输出
-- `toPdf()` 导出 PDF；使用内置 A4 排版示例参数导出
-- `toPdf2()` 导出 PDF；支持自定义参数，如缩放比例、页边距等(通过@zumer/snapdom库插件)
-- `toImage()` 导出图片；使用内置 A4 排版示例参数导出
-- `toImage2()` 导出图片；支持自定义参数，如缩放比例、页边距等(通过@zumer/snapdom库插件)
+- `toPdf()` 导出 PDF；使用基于 `@zumer/snapdom` 的导出链路，支持缩放比例、页边距、纸张排版等参数
+- `toImage()` 导出图片；使用基于 `@zumer/snapdom` 的导出链路，支持缩放比例、页边距、纸张排版等参数
 - `setHiwebSocket(host: string, token?: string, cb?: Function)` 设置客户端地址与令牌并尝试重连；`cb(status, msg)` 为连接回调
 - `connect(cb?: Function)` 主动连接客户端；`cb(status, msg)` 为连接回调
 - `disconnect()` 断开客户端连接
@@ -767,6 +785,8 @@ return (result.data || []).map(item => ({
 
 本库导出 `hiprint`，可直接创建与操作模板对象（`hiprint.PrintTemplate`）：
 
+若需要使用“直连打印/客户端连接（hiwebSocket）”相关能力，请先按上文注入 `io`；否则会提示缺失并导致连接失败。
+
 ```js
 import { hiprint, defaultElementTypeProvider } from 'vg-print'
 // 全局配置
@@ -834,8 +854,8 @@ tpl.toPdf(this.printDataVar, '打印预览pdf', {
     }
   }
 });
-// 这是使用@zumer/snapdom库插件导出PDF的示例，使用方式和toPdf一样
-tpl.toPdf2(this.printDataVar, '打印预览pdf', {
+// 使用当前保留的 toPdf 导出链路（基于 @zumer/snapdom）
+tpl.toPdf(this.printDataVar, '打印预览pdf', {
   onProgress: (cur, total) => { 
     // 导出进度100%的时候关闭等待
     if (cur === total) {
@@ -880,8 +900,8 @@ tpl.toImage(this.printDataVar, {
   }
 })
 
-// 这是使用@zumer/snapdom库插件导出图片的示例，使用方式和oImage一样
-tpl.toImage2(this.printDataVar, {
+// 使用当前保留的 toImage 导出链路（基于 @zumer/snapdom）
+tpl.toImage(this.printDataVar, {
   paperWidth: 210,
   paperHeight: 297,
   limit: 6,
@@ -911,9 +931,7 @@ import {
   getHtml,
   printBrowser,
   exportPdf,
-  exportPdf2,
   exportImage,
-  exportImage2,
   getPrinterList,
   refreshPrinterList,
   getAddress,
@@ -975,23 +993,6 @@ exportPdf(tpl, printData, '打印预览pdf', {
     }
 })
 
-// 插件方法
-exportPdf2(tpl, printData, '打印预览pdf', {
-  paperWidth: 210, 
-  paperHeight: 297, 
-  perPage: 6, 
-  leftOffset:-1, 
-  topOffset:-1, 
-  scale: 1,       // 清晰度/性能权衡（也可用 pixelRatio） 1:100% 2:200% 3:300%
-  pdfCompress: true, // 是否压缩PDF 默认 true
-  imageType: 'JPEG', // 图片类型 默认 JPEG 支持 JPEG、PNG
-  imageQuality: 0.92, // 图片质量 0-1 默认 0.92
-  imageCompression: 'FAST', // 图片压缩算法 默认 FAST 支持 FAST、MEDIUM、SLOW
-  onProgress: (cur: number, total: number) => { 
-    console.log('toPdf 进度', Math.floor((cur/total)*100))
-  }
-})
-
 // 原生方法
 await exportImage(tpl, printData, {
    isDownload: true, 
@@ -1007,20 +1008,6 @@ await exportImage(tpl, printData, {
   }
 })
 
-// 插件方法
-exportImage2(tpl, printData, {
-  paperWidth: 210,
-  paperHeight: 297,
-  limit: 6,
-  isDownload: true,
-  name: 'A4排版',
-  type: 'image/jpeg',
-  pixelRatio: 2,
-  onProgress: (cur: number, total: number) => {
-    console.log('toImage 进度', Math.floor((cur/total)*100))
-  }
-})
-
 // 6) 客户端直连打印（需要本地客户端）
 setHiwebSocket('http://127.0.0.1:17521', 'your-token') // 遵循 autoConnect 状态
 // 或者使用标准 API（设置即连接）
@@ -1093,10 +1080,6 @@ disconnect()
 exportPdf(tpl, printData, '打印预览pdf', {
   onProgress: (cur, total) => console.log('toPdf 进度', Math.floor((cur / total) * 100))
 })
-
-exportPdf2(tpl, printData, '打印预览pdf', {
-  onProgress: (cur, total) => console.log('toPdf 进度', Math.floor((cur / total) * 100))
-})
 ```
 
 #### 模式 B：排版导出（把小模板拼到大纸张，例如 A4）
@@ -1119,18 +1102,6 @@ exportPdf(tpl, printData, '打印预览pdf', {
   imageCompression: 'FAST', // 图片压缩算法 默认 FAST 支持 FAST、MEDIUM、SLOW
   onProgress: (cur, total) => console.log('toPdf 进度', Math.floor((cur / total) * 100))
 })
-
-exportPdf2(tpl, printData, '打印预览pdf', {
-  paperWidth: 210,      // mm
-  paperHeight: 297,     // mm
-  perPage: 6,           // 每页放 6 个（不够的到下一页）
-  leftOffset: -1,       // -1 表示水平居中；>=0 表示左边距 mm
-  topOffset: -1,        // -1 表示垂直居中；>=0 表示上边距 mm
-  scale: 1,             // 清晰度/性能权衡（也可用 pixelRatio）
-  pdfCompress: true, // 是否压缩PDF 默认 true
-  imageType: 'JPEG', // 图片类型 默认 JPEG 支持 JPEG、PNG
-  imageQuality: 0.92, // 图片质量 0-1 默认 0.92
-  imageCompression: 'FAST', // 图片压缩算法 默认 FAST 支持 FAST、MEDIUM、SLOW
   onProgress: (cur, total) => console.log('toPdf 进度', Math.floor((cur / total) * 100))
 })
 ```
@@ -1321,4 +1292,3 @@ const onSave = ({ template, data, templateId }) => {
 }
 </script>
 ```
-