@kdesigner/amis-vue

中文文档
0.2.0发布于 2026/11/01MITTypeScriptESM + CJS

KDesigner ami Vue适配层-基于veaury混合渲染,在Vue 3应用中使用ami页面

中文使用文档
文档目录6 节
  1. ✨ 特性
  2. 📦 安装
  3. 🚀 快速开始
  4. 📚 主要导出
  5. 🛠 开发与构建
  6. 📝 许可证

@kdesigner/amis-vue

License TypeScript Version

KDesigner AMIS Vue 适配层 - 基于 veaury 混合渲染,让你在 Vue 3 应用中无缝使用 AMIS(React)页面。

✨ 特性

  • 🔀 Vue / React 混合渲染 - 基于 veaury,在 Vue 3 中直接渲染 AMIS React 组件
  • 📄 页面渲染器 - XuiPage / AmisSchemaPage 开箱即用的 AMIS schema 渲染组件
  • ✏️ 编辑器组件 - XuiPageEditor / AmisPageEditor 可视化编辑器封装
  • 🌉 运行时适配 - registerAdapter 桥接 AMIS 与宿主框架(alert / confirm / notify / dataMapping)
  • 📦 聚合入口 - 透传 @kdesigner/core、@kdesigner/components、@kdesigner/amis-extensions 的全部导出
  • 🛡️ TypeScript - 100% TS 编写,提供完备的类型推导

📦 安装

pnpm add @kdesigner/amis-vue

Peer 依赖需自行安装:

pnpm add [email protected] [email protected] [email protected] react@^18 react-dom@^18 vue@^3 vue-router@^4

🚀 快速开始

// main.ts
import { createApp } from 'vue'
import { XuiPage, registerAdapter } from '@kdesigner/amis-vue'
import { alert, confirm, toast, dataMapping } from 'amis'

const app = createApp(App)

// 1. 注册 adapter(桥接 AMIS 与宿主)
registerAdapter({ dataMapping, alert, confirm, notify: toast })

// 2. 注册全局组件
app.component('XuiPage', XuiPage)

app.mount('#app')
<template>
  <XuiPage :schema="schema" />
</template>

<script setup lang="ts">
const schema = {
  type: 'page',
  title: 'Hello',
  body: 'AMIS in Vue!'
}
</script>

📚 主要导出

导出说明
XuiPage / XuiSchemaPage / AmisSchemaPageAMIS schema 页面渲染组件
XuiPageEditor / AmisPageEditor可视化编辑器组件
XuiLoading加载态组件
AmisToastToast 通知
createEnv / AmisVueComponent运行时环境与混合渲染组件
registerAdapterAMIS 与宿主的适配注册(来自 @kdesigner/core)

🛠 开发与构建

# 安装依赖
pnpm install

# 监视模式开发
pnpm dev

# 构建产物
pnpm build

# 运行测试
pnpm test

📝 许可证

MIT

版本与发布记录

@kdesigner/amis-vue 共发布 9 个版本,首次发布于 2026/09/29;过去 12 个月发布了 9 个版本。

版本发布日期距今
0.2.0latest2026/11/011 天前
0.1.12026/11/011 天前
0.1.02026/11/011 天前
0.0.12026/11/011 天前
0.0.02026/11/011 天前
0.0.0-alpha.42026/09/301 个月前

关于 @kdesigner/amis-vue 的常见问题

@kdesigner/amis-vue 是什么?

KDesigner ami Vue适配层-基于veaury混合渲染,在Vue 3应用中使用ami页面

如何安装 @kdesigner/amis-vue?

在项目目录运行 npm install @kdesigner/amis-vue,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:vue(>=3.0.0)、amis(6.11.0)、react(>=18.0.0)、amis-ui(6.11.0)、amis-core(6.11.0)、react-dom(>=18.0.0)、vue-router(>=4.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@kdesigner/amis-vue 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@kdesigner/amis-vue 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@kdesigner/amis-vue 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18.0.0 <25.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@kdesigner/amis-vue 可以商用吗?

@kdesigner/amis-vue 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@kdesigner/amis-vue 还在维护吗?

最新版本 0.2.0 发布于 2026/11/01(1 天前);至今共发布 9 个版本,其中过去 12 个月发布了 9 个;首次发布于 2026/09/29。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。