# @kdesigner/amis-vue 中文文档

规范地址：https://npmcn.com/package/%40kdesigner/amis-vue/

版本：0\.2\.0
npm 元数据更新时间：2026-11-01T14:40:56.837Z
中文译文更新时间：2026-11-01T15:18:07.802Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40kdesigner/amis-vue
原文对照：https://npmcn.com/package/%40kdesigner/amis-vue/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：275 kB，35 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0 \<25\.0\.0
- 运行依赖：7 个
- 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
- 首次发布：2026-09-29T06:11:19.979Z
- 最新版本发布：2026-11-01T14:40:56.611Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

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

## 安装

```sh
npm install @kdesigner/amis-vue
```

也可以使用：`pnpm add @kdesigner/amis-vue`、`yarn add @kdesigner/amis-vue`、`bun add @kdesigner/amis-vue`

## README

# @kdesigner/amis-vue

![License](https://img.shields.io/badge/license-MIT-blue.svg) ![TypeScript](https://img.shields.io/badge/typescript-%5E5.9.2-blue.svg) ![Version](https://img.shields.io/badge/npm-v/@kdesigner/amis-vue-blue.svg)

KDesigner AMIS Vue 适配层 - 基于 [veaury](https://github.com/gloriasoft/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 编写，提供完备的类型推导

## 📦 安装

```bash
pnpm add @kdesigner/amis-vue
```

Peer 依赖需自行安装：

```bash
pnpm add amis@6.11.0 amis-core@6.11.0 amis-ui@6.11.0 react@^18 react-dom@^18 vue@^3 vue-router@^4
```

## 🚀 快速开始

```typescript
// 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')
```

```vue
<template>
  <XuiPage :schema="schema" />
</template>

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

## 📚 主要导出

| 导出 | 说明 |
| --- | --- |
| `XuiPage` / `XuiSchemaPage` / `AmisSchemaPage` | AMIS schema 页面渲染组件 |
| `XuiPageEditor` / `AmisPageEditor` | 可视化编辑器组件 |
| `XuiLoading` | 加载态组件 |
| `AmisToast` | Toast 通知 |
| `createEnv` / `AmisVueComponent` | 运行时环境与混合渲染组件 |
| `registerAdapter` | AMIS 与宿主的适配注册（来自 `@kdesigner/core`） |

## 🛠 开发与构建

```bash
# 安装依赖
pnpm install

# 监视模式开发
pnpm dev

# 构建产物
pnpm build

# 运行测试
pnpm test
```

## 📝 许可证

MIT

## 常见问题

### @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 和提交记录判断。