Skip to content
什么时候升级到
什么时候升级到
Appearance
Chat 快速开始
@opentiny/tiny-robot-chat 提供三种官方接入方式:
TrChatTrChat.Root + TrChat.PageTrChat.Root + primitives
如果只需要快速启动一个聊天页,优先从 TrChat 开始。
安装
首次接入时,请同时安装以下依赖:
bash
pnpm add @opentiny/tiny-robot-chat @opentiny/tiny-robot @opentiny/tiny-robot-kit vue markstream-vue如果项目里已经安装了其中一部分,可以跳过重复安装;
仅安装 @opentiny/tiny-robot-chat 不足以运行最小示例。
样式引入
在应用入口文件(如 main.ts / main.js)中引入以下样式:
ts
import '@opentiny/tiny-robot/dist/style.css'
import '@opentiny/tiny-robot-chat/style'如果已经全局引入过 @opentiny/tiny-robot/dist/style.css,补充 @opentiny/tiny-robot-chat/style 即可。
什么时候看这一页
适合:
- 第一次接入
@opentiny/tiny-robot-chat - 快速搭建一个完整聊天页
- 想先知道应该选哪条接入路径
如果你更关心:
TrChat能配置什么TrChatConfig每个字段负责什么
继续看:
如果你更关心:
- 想自己创建 runtime
- 自定义页面结构
- 想保留我们的 UI 和聊天行为,但自己接 transport
继续看:
如何选择入口
| 你的目标 | 推荐入口 | 示例 |
|---|---|---|
| 快速启动完整聊天页 | TrChat | 基础示例 · 全量用法 |
| 自己创建 runtime,继续用官方页面 | TrChat.Root + TrChat.Page | Root + Page 示例 |
| 完全控制页面结构 | TrChat.Root + primitives | 手动组合示例 |
如果你想保留我们的 UI 和聊天行为,但需要自己接 transport / data-access,请看 Chat 自定义 里的 TrChat.Provider(transportAdapter)。
TrChat 最小示例
loading
TrChat 接受什么输入
TrChat 现在只接受两种 config 形态:
TrChatConfig对象TrChatConfig的序列化 JSON 字符串
如果需要自行创建 runtime、自定义页面结构或对接 transport,不建议在 TrChat 上添加更多顶层参数,请直接升级到以下路径。
最常改的配置
大多数场景里,最常修改的配置域:
request— 模型、transportconversation— 初始消息、持久化ui— 品牌、欢迎区、主题、文案sender— 输入区行为attachments— 附件上传history— 历史会话workspace— 左右分栏布局messages— 消息动作、渲染、反馈lifecycle— 发送前后钩子
完整字段参考见 Chat 配置。
什么时候升级到 Root + Page
适合这些情况:
- 你想自己决定 runtime 的创建时机
- 你想把聊天页包在业务容器里
- 你仍然想继续用官方页面结构
适合需要自行管理状态、但希望保留官方页面结构的场景。查看完整示例:Root + Page 示例
如果还需要自定义 workspace 的左右侧边栏内容,TrChat.Page 在 workspace 模式下支持 #left、#right、#left-rail slots,直接替换即可。查看示例:自定义布局示例
什么时候升级到 Root + primitives
适合这些情况:
- 你要自己排
Header / MessageList / Footer / History / Workspace - 你要在页面里插入自定义区域
- 你要单独使用
TrChat.Sender、TrChat.MessageList、TrChat.McpTrigger等叶子组件
适合需要完全控制页面组合的场景。查看完整示例:手动组合示例