@aleph-alpha/chat-kit (英语)
用于构建 Vue 聊天界面的聊天套件. 船舶部件、搬运工(通过 useMessageHandler,下标,标签——从套件根或 @aleph-alpha/chat-kit/handlers),用于 useChat (开发中)后端服务层 (开发中)。 。 。 .
部分 前端插头 单相机.
安装
pnpm add @aleph-alpha/chat-kit
建筑
Chat Kit 组织为 三层数字 :
- 构成部分 ——预建用于聊天的 Vue 3 组件,拆分为 基础 (介绍)和 编 成 (观点模式).
- 处理器 - 聊天国家管理反应公用事业:
useMessageHandler(对话树),useMarkdownParser(铺平管道),useChatKitLabels(i18n) (中文(简体) ). - 服务 (开发中) ——摘要
ChatService编号 :IChatService用于后端通讯和流出. 未就绪用于生产.
useChat (开发中) 住在这里 composables/ 作为规划中的高级管弦乐团,将处理器和服务编成一个单一的API
使用量
从特定切入点导入树摇:
// 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 单相机。 在当地开展工作:
git clone [email protected]: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
文档
- 概览 - 建筑和特征
- 快速启动 ——安装和最小聊天UI
- 搬运工和服务 ——信件状态,标记下,标签,服务
- API 参考 公共出口(部件、处理器、可堆肥物、服务、类型)
- CI/CD 流量 ——放行过程和公关检查
- 故事书部署 - 预览和制作故事书
许可证
麻省理工学院.