跳到主要内容

AG-UI React UI 接入

@cloudbase/agent-react-ui 提供可直接接入 React 项目的聊天界面组件,可用于快速对接符合 AG-UI 协议的 AI Agent。当前组件仅作参考,推荐使用 @cloudbase/agent-react-core 自定义 UI。

安装

npm install @cloudbase/agent-react-core @cloudbase/agent-react-ui @cloudbase/js-sdk

快速开始

导入样式:

import "@cloudbase/agent-react-ui/styles.css";

引用:

import cloudbase from "@cloudbase/js-sdk";
import { AgKit, CloudBaseTransport } from "@ag-kit/react-core";
import { AgKitUI } from "@cloudbase/agent-react-ui";

const app = cloudbase.init({ env: "your-env-id" });

app.auth.signInAnonymously();

const transport = new CloudBaseTransport({
app,
agentId: "your-agent-id",
});

export function App() {
return (
<AgKit transport={transport}>
{/* AgKitUI 默认继承父元素宽高 */}
<div style={{ height: "600px", width: "800px" }}>
<AgKitUI />
</div>
</AgKit>
);
}


API 参考

AgKitUI

核心聊天界面组件,内置了完整的消息渲染、工具调用展示、输入框和国际化支持。

AgKitUIProps

选项必填类型说明
classNamestring聊天主体布局类名
containerClassNamestring最外层根容器类名
messagesClassNamestring消息列表区域类名
inputClassNamestring输入框包裹层类名
emptyTitleClassNamestring空状态标题类名
inputPlaceholderstring输入框占位文本,未提供时使用 locale 默认值
suggestionsstring[]聊天为空时显示的建议问题列表
localezh-CN/en内置 UI 文案语言,默认 "zh-CN"
onSuggestionClick(suggestion: string) => void点击建议问题时触发的回调

示例:基础用法

<AgKitUI />

示例:自定义建议与语言

<AgKitUI
locale="zh-CN"
inputPlaceholder="输入你的问题"
suggestions={[
"帮我总结今天的工作",
"生成一份周报模板",
"解释这个接口的用途",
]}
onSuggestionClick={(value) => {
console.log("clicked suggestion:", value);
}}
/>

示例:自定义样式

<AgKitUI
containerClassName="my-chat-container"
messagesClassName="my-messages"
inputClassName="my-input"
emptyTitleClassName="my-empty-title"
/>