v3.2.5 · 插件化架构 · 为打印而生

插件化TypeScript 优先的 Vue 3 可视化画布设计器

按需启用图形元素,设计并打印标签、二维码、条码、票据、名片、证书--一切模板,一个组件。

Vue 3 Konva.js TypeScript MIT License
vkedit · label-template.json
A4 · 210×297mm · DPM 8就绪

基于 Vue 3 · Konva.js · TypeScript 构建

核心特性

为画布设计而生的完整能力

从插件化架构到毫米级打印,每一个能力都围绕"模板设计与打印排版"打磨。

架构

插件化架构

核心功能与图形元素均以插件形式注册,按需 installPlugin。装你所需,包体可控,扩展自由。

元素

7 种图形元素

矩形
文本
线条
表格
二维码
条码
图表
历史

撤销 / 重做

命令模式,所有修改可逆

数据

导入 / 导出

JSONPNGJPGPDF
排版

对齐与分布

左/右/上/下/居中、均分

精度

标尺与缩放

毫米级精度 · 可配 DPM

通信

事件驱动

host.on('element:added')
host.emit(...)
host.off(...)

类型

TypeScript

const p = host.getPlugin(
  'rect-plugin'
)
// ↳ RectPlugin

install.ts
 1import { createEditorHost } from 'vkedit' 2import { RectPlugin, TextPlugin, 3  QrcodePlugin, BarcodePlugin } from 'vkedit' 4  5const host = createEditorHost() 6  7host 8  .installPlugin('rect-plugin', RectPlugin) 9  .installPlugin('text-plugin', TextPlugin)10  .installPlugin('qr-plugin', QrcodePlugin)11  .installPlugin('barcode-plugin', BarcodePlugin)
矩形
文本
线条
表格
二维码
条码
图表

装你所需,包体可控

7 种图形元素 · 11 个核心插件 · 按需注册

插件化叙事

装你所需,包体可控

滚动见证一个画布从空到满--每装一个插件,多一种能力。

1

空画布就绪

createEditorHost()

创建宿主实例,自动安装 11 个核心插件。

2

矩形装配

.installPlugin('rect-plugin', RectPlugin)

注册矩形插件,画布落下第一个矩形。

3

文本装配

.installPlugin('text-plugin', TextPlugin)

注册文本插件,添加标题与说明。

4

二维码装配

.installPlugin('qr-plugin', QrcodePlugin)

注册二维码插件,像素逐个点亮。

5

条码装配

.installPlugin('barcode-plugin', BarcodePlugin)

注册条码插件,扫描线生成条码。

6

按需注册

装你所需,包体可控

7 种图形元素,11 个核心插件,按需启用。

在线体验

真实编辑器,拖拽即用

这是一个自包含的迷你画布演示:从左侧添加元素,拖拽定位,右侧改属性,一键导出 PNG。真实 vkedit 编辑器能力完整一致。

label-template GitHub

提示:拖拽元素 · 点击选中 · 右侧改属性 · 导出 PNG

属性面板

点击画布上的元素查看属性,或从左侧工具箱添加新元素。

适用场景

一个组件,覆盖所有模板场景

标签、二维码、条码、票据、名片、证书、数据可视化--按场景装配插件,所见即所得。

标签模板设计

二维码条形码文本矩形表格

二维码设计

二维码文本矩形

条码设计

条形码文本线条

票据设计

表格文本矩形线条

名片设计

文本矩形线条

证书设计

文本矩形表格

数据可视化

图表文本矩形
快速上手

三步跑起你的第一个模板

安装、配置入口、使用组件--不到 30 行代码,拥有一个完整的可视化画布设计器。

bash
pnpm add vkedit vue konva vue-konva

vkedit 将 vue、konva、vue-konva 作为 peerDependencies,由宿主项目提供。

安装文档
Node.js ^20.19.0 || ≥22.12.0 · 完整文档
插件全景

21 个插件,按需启用

核心能力内置,功能与图形插件按场景装配--装你所需,包体可控。

核心插件 核心

createEditorHost 自动安装

11
  • ToolbarManagerPlugin 顶部工具栏管理
  • GraphicToolManagerPlugin 图形工具管理
  • GraphicManagerPlugin 图形渲染管理
  • PropertyPanelManagerPlugin 属性面板动态渲染
  • ElementManagerPlugin 元素生命周期管理
  • SelectionPlugin 元素选择与多选
  • KeyDownPlugin 键盘快捷键
  • SnapPlugin 网格吸附
  • ClipboardPlugin 复制 / 剪切 / 粘贴
  • AlignPlugin 对齐与分布
  • ContextMenuManagerPlugin 右键菜单

功能插件 功能

通过选项启用

3
  • ExportPlugin 导出 JSON / PNG / JPG / PDF
  • ImportPlugin 导入 JSON 文件
  • PreviewPlugin 预览与打印预览

图形插件 图形

手动 installPlugin

7
  • RectPlugin 矩形 - 填充、描边
  • TextPlugin 文本 - 字体、对齐、样式
  • LinePlugin 线条 - 颜色、宽度
  • TablePlugin 表格 - 行列、合并、边框
  • QrcodePlugin 二维码 - 前景/背景色
  • BarcodePlugin 条形码 - CODE128 / EAN-13
  • ChartPlugin 图表 - 基于 ECharts

插件通过 installPlugin / uninstallPlugin / getPlugin 管理,getPlugin 支持泛型推断。

常见问题

你可能想知道的

关于商用、框架、包体、扩展与打印的常见疑问,一次说清。

vkedit 和 Fabric.js / 原生 Konva 有什么区别?
vkedit 基于 Vue 3 + Konva.js 构建,在底层画布能力之上提供插件化架构、命令模式(撤销/重做)、属性面板、导入导出、标尺缩放等开箱即用的编辑器能力,聚焦标签/票据等模板设计与打印排版。Fabric.js 与原生 Konva 是通用的画布渲染库,编辑器交互需自行实现。
可以商用吗?
可以。vkedit 采用 MIT 许可证,可免费用于商业项目、修改和分发,仅需保留版权声明。
支持哪些框架?
基于 Vue 3 构建,需配合 vue-konva 使用。vue、konva、vue-konva 作为 peerDependencies 由宿主项目提供。
包体多大?能否按需引入?
采用插件化架构:createEditorHost 自动安装 11 个核心插件,功能插件与 7 个图形插件通过 installPlugin 按需启用。只装配你需要的图形元素,可有效控制最终包体。 查看文档:插件系统
如何自定义图形插件?
继承 BasePlugin 并实现 onInstall() 钩子,在其中注册图形元素类型、工具项与属性面板。插件通过 installPlugin / uninstallPlugin / getPlugin 管理,getPlugin 支持泛型推断返回具体插件类型。 查看文档:自定义插件开发
支持打印预览吗?
内置 PreviewPlugin,支持预览与打印预览。通过 setStatus 配置 DPM(每毫米点数)即可实现毫米级精度的打印输出,并支持导出 PNG / JPG / PDF。 查看文档:功能插件
Node 版本要求?
Node.js ^20.19.0 || >=22.12.0。建议使用 pnpm 管理依赖。
是否支持移动端?
底层基于 Konva 的画布支持触摸交互。但复杂的模板编辑场景(多选、对齐分布、属性调整)建议在桌面端体验,移动端适合预览与轻量调整。
准备好了吗

开始构建你的第一个模板

一行命令安装,按需启用插件,从空白画布到可打印的成品,只需一个组件。

install
pnpm add vkedit vue konva vue-konva