安装

环境要求

依赖	最低版本	推荐版本	说明
Node.js	20.19+	22.x LTS	构建工具链要求
Vue	3.5+	^3.5.18	peerDependency
Konva	10.0+	^10.0.2	peerDependency
vue-konva	3.2+	^3.2.6	peerDependency

包管理器推荐

vkedit 使用 pnpm 进行开发，推荐使用 pnpm 安装以获得最佳体验。npm 和 yarn 同样支持。

安装 vkedit

选择你喜欢的包管理器：

pnpm

pnpm add vkedit vue konva vue-konva

npm

npm install vkedit vue konva vue-konva

yarn

yarn add vkedit vue konva vue-konva

peerDependencies 说明

vkedit 将以下包作为 peerDependencies，需要你自行安装：

包	版本	原因
vue	^3.5.18	vkedit 是 Vue 组件库，Vue 由宿主应用提供
konva	^10.0.2	Canvas 渲染引擎，避免重复安装
vue-konva	^3.2.6	Vue 3 的 Konva 绑定层

注意

如果安装后运行时报 Cannot find module 'konva' 或类似错误，说明 peerDependencies 未正确安装。请确保执行了上面的安装命令。

验证安装

在项目中创建一个测试文件，验证 vkedit 可正常导入：

// test-import.ts
import { EditorHost, Vkedit } from 'vkedit'

console.log('EditorHost:', typeof EditorHost)
console.log('Vkedit:', typeof Vkedit)

如果控制台输出 function（或 object），说明安装成功。

下一步

• 快速上手 -- 配置项目并运行第一个编辑器