vg-print 1.0.226 → 1.0.227

package/README.md

@@ -85,32 +85,32 @@ const disableAutoConnect = () => designer.value.disAutoConnect()
 
 ## API（FullDesigner）
 
-### 属性（Props）
+### 属性（Props，含描述）
 
-- `hi-host: string` 客户端服务地址（`hiwebSocket.host`），如 `http://127.0.0.1:17521`
-- `hi-token: string` 客户端鉴权令牌（`hiwebSocket.token`）
-- `hi-auto-connect: boolean` 是否自动连接客户端，默认 `true`
-- `initial-template: object` 初始化模板 JSON（为空则使用内置示例）
-- `initial-print-data: object | array` 初始化打印数据（对象或数组）
-- `default-lang: string` 默认语言（`cn`、`en`、`de` 等；默认 `cn`）
+- `hi-host: string` 客户端服务地址；示例 `http://127.0.0.1:17521`，用于直连打印
+- `hi-token: string` 客户端鉴权令牌；与客户端配置一致时方可直连打印
+- `hi-auto-connect: boolean` 是否自动连接客户端；默认 `true`，为 `false` 时需手动调用 `connect()`
+- `initial-template: object` 初始化模板 JSON；为空时使用内置示例模板
+- `initial-print-data: object | array` 初始化打印数据；支持对象或数组，运行时变更会即时生效
+- `default-lang: string` 默认语言；支持 `cn`、`en`、`de`、`es`、`fr`、`it`、`ja`、`ru`、`cn_tw`；默认 `cn`
 
-以上属性支持运行时动态修改，组件内部会监听并应用。
+以上属性支持运行时动态修改；组件内部已监听并应用。
 
-### 方法（通过组件 ref 调用）
+### 方法（通过组件 ref 调用，含描述）
 
-- `preView()` 打开预览弹窗
-- `printView()` 浏览器打印
-- `print()` 直接打印（需客户端已连接）
-- `toPdf()` 导出为 PDF（内置示例参数）
-- `toImage()` 导出为图片（内置示例参数）
-- `setHiwebSocket(host: string, token?: string, cb?: Function)` 设置客户端地址与令牌并重连
-- `connect(cb?: Function)` 主动连接客户端
-- `disconnect()` 断开客户端
-- `disAutoConnect()` 关闭自动连接策略
+- `preView()` 打开预览弹窗；将当前模板与数据渲染为预览 HTML
+- `printView()` 浏览器打印；不依赖客户端，调起系统打印对话框
+- `print()` 直接打印；需客户端已连接，按当前选定打印机输出
+- `toPdf()` 导出 PDF；使用内置 A4 排版示例参数导出
+- `toImage()` 导出图片；使用内置 A4 排版示例参数导出
+- `setHiwebSocket(host: string, token?: string, cb?: Function)` 设置客户端地址与令牌并尝试重连；`cb(status, msg)` 为连接回调
+- `connect(cb?: Function)` 主动连接客户端；`cb(status, msg)` 为连接回调
+- `disconnect()` 断开客户端连接
+- `disAutoConnect()` 关闭自动连接策略；阻止自动重连
 
-### 事件（Emits）
+### 事件（Emits，含描述）
 
-- `save` 保存模板与数据。回调参数结构：
+- `save` 保存模板与数据；回调参数结构：
 
 ```js
 {
@@ -299,30 +299,30 @@ await exportImage(tpl, printData, {
 })
 ```
 
-### 参数说明（PDF/图片通用）
+### 参数说明（PDF/图片通用，含描述）
 
-- `paperWidth`、`paperHeight`：整数或浮点数，单位 mm；传入后按该纸张排版，不传则使用模板自身尺寸与分页。
-- `scale`：缩放系数；用于提高渲染清晰度或控制排版密度（PDF）。
-- `perPage`：每页排版的模板数量（PDF）；通常用于小模板拼接到 A4。
-- `leftOffset`、`topOffset`：对齐偏移（mm），用于微调整体排版位置（PDF）。
-- `limit`：图片导出的合并页数。1 表示每张合 1 页；6 表示每张合 6 页；0 或不传表示导出整图。
-- `type`：导出图片格式，`'image/jpeg'` 或 `'image/png'`。
-- `pixelRatio`：像素比例；越大越清晰，文件越大（图片）。
-- `quality`：图片质量（0-1，仅 JPEG 有效）。
-- `toType`：不下载时返回类型（`'url'` 或 `'blob'`）。
-- `isDownload`：是否直接下载文件（图片）。
-- `name`：文件名或下载名。
-- `onProgress(cur, total)`：导出进度回调；`cur/total` 计算百分比。
+- `paperWidth`、`paperHeight` 纸张尺寸（mm）；传入后按该纸张排版，不传则使用模板自身尺寸与分页
+- `scale` 渲染缩放（PDF）；提升清晰度或控制排版密度
+- `perPage` 每页模板数量（PDF）；用于小模板排版到大纸张
+- `leftOffset`、`topOffset` 对齐偏移（mm）；微调整体排版位置（PDF）
+- `limit` 图片合并页数；1 表示每张 1 页，6 表示每张 6 页；0/不传导出整图
+- `type` 图片格式；`'image/jpeg'` 或 `'image/png'`
+- `pixelRatio` 像素比例（图片）；越大越清晰但文件更大
+- `quality` 图片质量（0-1，仅 JPEG 有效）
+- `toType` 返回类型（不下载时）；`'url'` 或 `'blob'`
+- `isDownload` 是否直接下载图片文件
+- `name` 文件名或下载名
+- `onProgress(cur, total)` 导出进度回调；以 `cur/total` 计算百分比
 
-### 导入说明
+### 导入说明（含描述）
 
-- 上述 API 已由库入口直接导出，无需单独安装 `vue-plugin-hiprint`。
-- 若需要自定义元素提供器，可在调用前执行 `hiprint.init({ providers: [...] })`；默认已初始化内置提供器。
+- 所有运行时 API 由库入口直接导出；无需另装 `vue-plugin-hiprint`
+- 如需自定义元素提供器，在调用前执行 `hiprint.init({ providers: [...] })`；默认已初始化内置提供器
 
-### 适用场景
+### 适用场景（含描述）
 
-- 后台页面、弹窗、任务流等，只做“数据 + 模板”的快速预览/打印/导出
-- 服务端或脚本批量导出（结合 `exportPdf`/`exportImage`）
+- 后台页面、弹窗、任务流：仅需“模板 + 数据”的预览/打印/导出能力
+- 脚本或批量任务：结合 `exportPdf`/`exportImage` 实现批量导出
 
 
 ## 注意事项