# @aleph-alpha/chat-kit 中文文档

规范地址：https://npmcn.com/package/%40aleph-alpha/chat-kit/

版本：7\.2\.1
npm 元数据更新时间：2026-11-04T14:48:55.570Z
中文译文更新时间：2026-11-05T21:49:10.938Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40aleph-alpha/chat-kit
原文对照：https://npmcn.com/package/%40aleph-alpha/chat-kit/?lang=original
项目主页：https://github.com/Aleph-Alpha/frontend-hub#readme
源码仓库：https://github.com/Aleph-Alpha/frontend-hub

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

- 包体积（解压后）：8.7 MB，729 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：19 个
- peer 依赖：vue ^3\.5\.27，pinia ^3\.0\.0，@aleph-alpha/ui-library ^7\.0\.0
- 首次发布：2026-03-09T15:35:49.107Z
- 最新版本发布：2026-11-04T14:48:54.909Z
- 近 30 天下载量：15536（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 89 个）

## 中文简介

用于构建 Vue 聊天界面的聊天套件

## 安装

```sh
npm install @aleph-alpha/chat-kit
```

也可以使用：`pnpm add @aleph-alpha/chat-kit`、`yarn add @aleph-alpha/chat-kit`、`bun add @aleph-alpha/chat-kit`

## README

# @aleph-alpha/chat-kit (英语)

用于构建 Vue 聊天界面的聊天套件. 船舶部件、搬运工(通过 `useMessageHandler`,下标,标签——从套件根或 `@aleph-alpha/chat-kit/handlers`),用于 `useChat` _(开发中)_后端服务层 _(开发中)_。 。 。 .

> 部分 [前端插头](https://github.com/Aleph-Alpha/frontend-hub) 单相机.

## 安装

```bash
pnpm add @aleph-alpha/chat-kit
```

## 建筑

Chat Kit 组织为 **三层**数字 :

1.  **构成部分** ——预建用于聊天的 Vue 3 组件,拆分为 **基础** (介绍)和 **编 成** (观点模式).
2.  **处理器** - 聊天国家管理反应公用事业: `useMessageHandler` (对话树), `useMarkdownParser` (铺平管道), `useChatKitLabels` (i18n) (中文(简体) ).
3.  **服务** _(开发中)_ ——摘要 `ChatService` 编号 : `IChatService` 用于后端通讯和流出. 未就绪用于生产.

`useChat` _(开发中)_ 住在这里 `composables/` 作为规划中的高级管弦乐团,将处理器和服务编成一个单一的API

## 使用量

从特定切入点导入树摇:

```typescript
// Services only
import { ChatService, type IChatService } from '@aleph-alpha/chat-kit/services';

// Handlers only
import { useMessageHandler } from '@aleph-alpha/chat-kit/handlers';

// Composables only
import { useChat } from '@aleph-alpha/chat-kit/composables';

// Components only
import { CkConversation } from '@aleph-alpha/chat-kit/components';

// Everything
import { ChatService, useChat, CkConversation } from '@aleph-alpha/chat-kit';
```

## 发展

这个包裹住在 `frontend-hub` 单相机。 在当地开展工作:

```bash
git clone git@github.com:Aleph-Alpha/frontend-hub.git
cd frontend-hub
pnpm install

# Run tests
pnpm nx run chat-kit:test

# Lint
pnpm nx run chat-kit:lint

# Storybook
pnpm nx run chat-kit:storybook
```

## 文档

-   [概览](https://npmcn.com/package/%40aleph-alpha/chat-kit/docs/overview.md) - 建筑和特征
-   [快速启动](https://npmcn.com/package/%40aleph-alpha/chat-kit/docs/quick-start.md) ——安装和最小聊天UI
-   [搬运工和服务](https://npmcn.com/package/%40aleph-alpha/chat-kit/docs/handlers-and-services.md) ——信件状态,标记下,标签,服务
-   [API 参考](https://npmcn.com/package/%40aleph-alpha/chat-kit/docs/reference.md) 公共出口(部件、处理器、可堆肥物、服务、类型)
-   [CI/CD 流量](https://npmcn.com/package/.github/documentation/GITHUB_CI_FLOW.md) ——放行过程和公关检查
-   [故事书部署](https://npmcn.com/package/.github/documentation/STORYBOOK_DEPLOYMENT.md) - 预览和制作故事书

## 许可证

麻省理工学院.

## 常见问题

### @aleph-alpha/chat-kit 是什么？

用于构建 Vue 聊天界面的聊天套件

### 如何安装 @aleph-alpha/chat-kit？

在项目目录运行 npm install @aleph-alpha/chat-kit，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.5\.27）、pinia（^3\.0\.0）、@aleph-alpha/ui-library（^7\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aleph-alpha/chat-kit 支持 TypeScript 吗？

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

### @aleph-alpha/chat-kit 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aleph-alpha/chat-kit 需要什么版本的 Node\.js？

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

### @aleph-alpha/chat-kit 可以商用吗？

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

### @aleph-alpha/chat-kit 的下载量有多少？

根据 npm 官方下载统计，@aleph-alpha/chat-kit 在 2026/10/06 – 2026/11/04 这 30 天内被下载 15,536 次，日均约 518 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aleph-alpha/chat-kit 还在维护吗？

最新版本 7\.2\.1 发布于 2026/11/04（1 天前）；至今共发布 89 个版本，其中过去 12 个月发布了 89 个；首次发布于 2026/03/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。