vue-print-designer 0.9.0

package/LICENSE

@@ -0,0 +1,187 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Xiang DeZhi 上海未来申创智能科技有限公司
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,168 @@
+<p align="center">
+    <img src="./src/assets/logo.png" alt="Vue Print Designer" width="96" height="96" />
+</p>
+
+<h1 align="center">Vue Print Designer</h1>
+
+<p align="center">
+    中文 | <a href="./README_EN.md">English</a>
+</p>
+
+Vue Print Designer 是一款可视化打印设计器，面向业务表单、标签、票据、快递单等场景，支持模板化、变量化，并提供静默打印与云打印能力，同时兼容多种导出/打印方式。
+
+## 我们解决了什么问题
+
+- 设计与打印链路割裂，模板无法复用，改一个字段要改一堆代码
+- 复杂分页（尤其是表格）需要大量手写逻辑
+- 业务系统与打印插件的集成成本高、接口不统一、跨框架兼容性差
+
+## 为什么比同类更好用
+
+很多同类插件要么强耦合框架、要么只提供“导出图片/打印”而缺少工程化能力。我们的优势是：
+
+- **完整设计器**：元素、属性、分页、预览、模板管理一体化
+- **可扩展**：模板与自定义元素可以走本地存储，也能接入你的 API
+- **跨框架**：Web Components 方式适配 Vue/React/Angular/纯 HTML
+- **工程化**：导出 PDF/图片/Blob、打印参数、静默打印、连接配置都可控
+- **可维护**：代码结构清晰，便于二次开发与业务定制
+
+## 功能亮点
+
+- 拖拽式页面编辑，支持文本、图片、条码、二维码、表格、形状
+- 表格自动分页（支持表头/表尾重复）
+- 多页面布局、网格/标尺、缩放与对齐工具
+- 导出 PDF/图片/Blob，支持拼接/分片
+- 打印参数配置：打印机、份数、页范围、单双面、纸张等
+- **静默打印**：支持本地客户端直打，无需人工确认
+- **云打印**：支持远程客户端接入与云端下发打印任务
+
+## 界面预览
+
+|  |  |
+| --- | --- |
+| **设计器主界面与画布视图**<br>![设计器主界面](docs/images/1.png) | **打印预览**<br>![打印预览](docs/images/2.png) |
+| **打印参数配置**<br>![打印参数](docs/images/3.png) | **系统设置与偏好**<br>![系统设置](docs/images/4.png) |
+| **快捷键说明**<br>![快捷键](docs/images/5.png) | **高级表格编辑**<br>![高级表格](docs/images/6.png) |
+
+## 引入方式一：下载源码自行改造与集成 API
+
+适合有深度定制需求的团队。
+
+```bash
+npm install
+npm run dev
+```
+
+建议接入点：
+
+- 模板 CRUD：`useTemplateStore`（可替换为接口读写）
+- 自定义元素 CRUD：`useDesignerStore` 中的 `customElements`
+- 变量与模板数据：组件实例方法 `setVariables` / `loadTemplateData`
+
+自定义元素扩展请看： [docs/zh/guide/custom-element.md](docs/zh/guide/custom-element.md)
+
+构建：
+
+```bash
+npm run build
+```
+
+## 引入方式二：npm 组件（Web Components）
+
+适合任何技术栈（Vue/React/Angular/原生）。
+
+说明：Web Components 方式**支持 Vue 2**（作为自定义元素使用），无需 Vue 2 组件适配。
+
+详细参数、CRUD 与 JSON 示例请看： [docs/zh/guide/web-components-guide.md](docs/zh/guide/web-components-guide.md)
+
+```bash
+npm install @your-scope/print-designer
+```
+
+### 1) 使用组件（Vue 3 / Vite）
+
+在入口文件中引入：
+
+```ts
+// main.ts
+import '@your-scope/print-designer';
+import '@your-scope/print-designer/style.css';
+```
+
+然后在页面里直接使用自定义元素：
+
+```vue
+<template>
+    <print-designer id="designer"></print-designer>
+</template>
+```
+
+### 2) Vue 3 选项式 API：初始化与调用分离
+
+**设计器页（初始化与编辑）**
+
+```vue
+<script lang="ts">
+export default {
+    mounted() {
+        const el = this.$refs.designerRef as any;
+        // 初始化品牌与主题
+        el.setBranding({ title: '业务打印设计器', showLogo: true });
+        el.setTheme('light');
+        // 初始化模板或变量
+        el.loadTemplateData(/* 从你的 API 获取的数据 */);
+        el.setVariables({ orderNo: 'A001' }, { merge: true });
+    }
+};
+</script>
+
+<template>
+    <print-designer ref="designerRef"></print-designer>
+</template>
+```
+
+**业务页面（随处调用打印/导出）**
+
+```ts
+// 任何页面中只要能拿到元素实例即可
+const el = document.querySelector('print-designer') as any;
+
+// 打印
+await el.print({ mode: 'browser' });
+
+// 导出 PDF / 图片 / Blob
+await el.export({ type: 'pdf', filename: 'order-20240223.pdf' });
+const pdfBlob = await el.export({ type: 'pdfBlob' });
+```
+
+### 3) 事件回调
+
+```ts
+el.addEventListener('ready', () => {});
+el.addEventListener('printed', (e) => {});
+el.addEventListener('exported', (e) => {
+    const blob = e.detail?.blob;
+});
+el.addEventListener('error', (e) => {
+    console.error(e.detail?.scope, e.detail?.error);
+});
+```
+
+## 构建 Web Components 包
+
+```bash
+npm run build:wc
+```
+
+产物：
+
+- `dist/print-designer.es.js`
+- `dist/print-designer.umd.js`
+- `dist/print-designer.css`
+- `dist/web-component.d.ts`
+
+## License
+
+Apache-2.0
+
+品牌与 Logo 使用请遵循 [TRADEMARKS.md](TRADEMARKS.md)。如需移除或替换品牌标识，请参考 [COMMERCIAL_LICENSE.md](COMMERCIAL_LICENSE.md)。