TinyRobotSender从v0.3自研编辑器升级至v0.4基于Tiptap的可插拔架构,通过扩展体系和插槽解耦功能。采用ProseMirror文档模型支持结构化数据,提供便捷函数与标准配置双轨API。新增loading/disabled状态管理、single/multiple智能输入模式切换及按钮组件化设计,提升灵活性与可维护性。
TinyRobot Sender 从 v0.3 到 v0.4 经历了一次重大架构升级——从自研编辑器切换到基于 Tiptap 的输入区组件架构。这不仅是引擎替换,更是一套可插拔化重构:扩展体系、按钮组件化、插槽体系、兼容层设计……每一项技术决策都经过深入考量。

长期稳定更新的攒劲资源: >>>点此立即查看<<<
本文将深入拆解 TinyRobot Sender 输入区组件的核心设计原理,详细解读那些隐藏在 API 文档背后的架构决策。
v0.3 版本的 Sender 输入区组件是一个功能耦合的组件——模板、提及、联想、语音、上传、主题全部集中在 props 中。这种组件设计在早期快速迭代时尚可应付,但随着功能增加,问题逐渐显现:
buttonGroup、speech、suggestions 等 props 堆叠,配置项越来越多v0.4 版本的升级思路非常清晰:解耦——将内置在 props 中的功能拆分为独立模块,通过 extensions 和插槽体系进行组件组装。
v0.3 架构:
Sender props → templateData / suggestions / allowSpeech / allowFiles / buttonGroup / theme
v0.4 架构:
Sender props → extensions (Template/Mention/Suggestion) + slots (VoiceButton/UploadButton) + ThemeProvider
Sender 输入区组件的 extensions prop 类型直接继承自 Tiptap:
import type { Extension } from '@tiptap/core'
interface SenderProps {
extensions: Extension[] // 默认为空数组
}
Tiptap 的 Extension 是其插件核心,每个 Extension 可以实现:
Sender 输入区组件中的 Template、Mention、Suggestion 三个扩展,本质上是 Tiptap Extension 的实例:
block 和 select 两种自定义 Nodemention Node,以特殊节点形式插入编辑器每个扩展都提供了两种集成方式:
// 便捷函数
TrSender.mention(mentions, '@')
TrSender.template(templateData)
TrSender.suggestion(suggestions)
// 标准配置
TrSender.Mention.configure({ items: mentions, char: '@', allowSpaces: false })
TrSender.Template.configure({ items: templateData })
TrSender.Suggestion.configure({ items: suggestions, filterFn: customFilter })
这里有一个组件设计细节值得深入思考:
便捷函数本质上是标准配置的参数简化版,目的是降低使用门槛,一行代码即可运行。但便捷函数隐藏了部分配置项(如 allowSpaces、onSelect、popupWidth),这些在复杂场景中必不可少。
两者的实现关系:
// 便捷函数内部实现(伪代码)
TrSender.mention = (items, char = '@') => {
return TrSender.Mention.configure({ items, char })
}
TrSender.suggestion = (items, options?) => {
return TrSender.Suggestion.configure({ items, ...options })
}
这种"简洁版 + 完整版"的双轨设计在组件库中较为常见(如 Ant Design 的 Form.create() vs Form.useForm())。但需要谨慎维护——两条 API 路径的差异必须在文档中明确说明,避免用户困惑:"为什么便捷函数不能配置 X?"
v0.3 版本的 Sender 使用自研 textarea 编辑器,功能有限,仅支持纯文本输入。v0.4 版本选择 Tiptap 作为底层引擎,主要基于以下考虑:
ProseMirror 的文档是一个树形结构,每个节点(Node)包含类型、属性和内容。Sender 输入区编辑器中的文档结构大致如下:
doc
└── paragraph
├── text("请帮我分析 ")
├── mention({ label: "张三", value: "用户ID" })
└── text(" 的周报")
这种结构化文档模型是 submit 事件返回 StructuredData 的基础——遍历文档节点即可提取所有特殊节点的信息。
type StructuredData = TemplateItem[] | MentionStructuredItem[]
StructuredData 采用联合类型,根据启用的扩展类型返回不同结构。submit 事件的双参数设计(text + data)遵循以下原则:
这种双参数设计避免了"要么只有纯文本,要么必须解析结构"的两难困境,开发者可根据业务需求灵活选择。
Sender 输入区组件的状态管理围绕两个核心属性展开:
interface SenderProps {
loading: boolean // 默认 false
}
loading 状态会联动 UI:
stopText(默认"停止响应")loading 自动失效// Events
interface SenderEvents {
cancel: () => void // v0.4 新增
}
cancel 事件的设计逻辑清晰:用户点击停止按钮 → 触发 cancel 事件 → 开发者中止 AI 响应请求(如 abortRequest())→ 设置 loading = false。
disabled 和 loading 的区别微妙:disabled 表示"不可用",loading 表示"正在处理"。两者都会禁用编辑器,但 disabled 不会显示停止按钮。
type InputMode = 'single' | 'multiple'
interface SenderProps {
mode: InputMode // 默认 'single'
}
这是 Sender 输入区组件最精巧的交互之一。在单行模式下:
submitType="enter" 时,按 Ctrl+Enter 或 Shift+Enter 也会自动切到多行模式并换行实现原理简单:编辑器监听内容变化,当检测到内容高度超过单行阈值时,内部状态从 single 切换为 multiple,同时调整编辑器高度和布局。
// 内部实现(伪代码)
watch(contentHeight, (height) => {
if (mode === 'single' && height > singleLineThreshold) {
internalMode.value = 'multiple'
}
})
// 换行快捷键触发
if (mode === 'single' && submitType === 'enter') {
// Ctrl+Enter / Shift+Enter → 自动切换多行 + 换行
handleKeyDown(event) {
if (isLineBreakShortcut(event)) {
switchToMultipleMode()
insertNewLine()
}
}
}
这种"智能切换"避免了用户手动在单行和多行之间切换的繁琐——单行模式适合简短输入,输入变长后自然过渡为多行。
type SubmitType = 'enter' | 'ctrlEnter' | 'shiftEnter'
interface SenderProps {
submitType: SubmitType // 默认 'enter'
}
| submitType | 提交快捷键 | 换行快捷键 |
|---|---|---|
enter | Enter | Ctrl+Enter / Shift+Enter |
ctrlEnter | Ctrl+Enter | Enter |
shiftEnter | Shift+Enter | Enter |
单行模式下,Enter 键的行为取决于 submitType:
submitType="enter":Enter 提交(单行模式不需要换行)submitType="ctrlEnter":Ctrl+Enter 提交,Enter 无效果(单行模式下 Enter 不换行)submitType="shiftEnter":Shift+Enter 提交当用户按下换行快捷键时,会触发模式切换:从 single 切换到 multiple,然后插入换行。
| 快捷键 | 功能 | 适用条件 |
|---|---|---|
| Enter | 提交 / 换行 | submitType="enter" |
| Ctrl+Enter | 提交 / 换行 | submitType="ctrlEnter" / submitType="enter" |
| Shift+Enter | 提交 / 换行 | submitType="shiftEnter" / submitType="enter" |
| Tab | 选中联想项 | 联想开启时 |
| Esc | 关闭联想 | 联想开启时 |
| ↑ / ↓ | 导航联想项 | 联想开启时 |
activeSuggestionKeys(默认 ['Enter'])可自定义选中联想项的按键,支持同时绑定多个键。
// v0.3 的按钮配置(已移除)
interface ButtonGroupConfig {
submit: { disabled, tooltip, icon }
clear: { disabled, tooltip, icon }
voice: { disabled, tooltip, icon, speechConfig }
file: { disabled, tooltip, icon, accept, multiple }
}
v0.3 将所有按钮配置集中在一个 buttonGroup prop 中,这种组件设计存在以下问题:
ButtonGroupConfig 类型定义v0.4 的组件设计方法直接明确:拆分。
defaultActions prop 配置// v0.4 的基础按钮配置
interface DefaultActions {
submit: { disabled, tooltip, tooltipPlacement }
clear: { disabled, tooltip, tooltipPlacement }
}
// 增强按钮是独立组件
import { VoiceButton, UploadButton } from '@opentiny/tiny-robot'
这种组件化设计的优势:
VoiceButton 和 UploadButton 不是 Sender 的子组件,而是平级的独立组件。它们:
这种"平级组件 + 插槽组合"模式,是 Vue 组件设计中的高级玩法——组件之间不是父子关系,而是协作关系。
SenderCompat 是为 v0.3 用户准备的过渡组件,它保留了 v0.3 的大部分 API,内部实现则委托给 v0.4 Sender:
v0.3 API → SenderCompat(适配层)→ v0.4 Sender(核心实现)
适配层的核心职责:
setTemplateData())SenderCompat 的性能损耗主要来自 Props 转换和事件映射的计算。由于适配层非常薄(仅涉及数据格式转换),实际损耗控制在 10% 以内,甚至比 v0.3 的自研实现有性能提升(得益于 Tiptap 的优化)。
方案 A:快速迁移(推荐)
v0.3 Sender → SenderCompat(修改导入,小幅调整)
方案 B:完全升级(目标)
SenderCompat → v0.4 Sender(使用新 API)
SenderCompat 是过渡组件,将在未来版本(如 v1.0.0)中废弃。但它的存在让 v0.3 用户可以渐进式迁移,无需一次性重写所有代码。
回顾 TinyRobot Sender v0.4 输入区组件的架构,可以提炼出以下核心设计原则:
这些组件设计原则不仅适用于 TinyRobot Sender,也可作为 Vue 组件库设计的重要参考范式。
侠游戏发布此文仅为了传递信息,不代表侠游戏网站认同其观点或证实其描述