@flutchai/聊天反应
为 a 进行回放聊天 UI 小花头 探员 可带有 CSS 变量的主题;可全部替换下标渲染器,按钮,消息行和附件渲染器.
联合调查组与 您的后端永远不要直接对小蝶。 您的后端持有 Flutch API 密钥并转发请求( 见 @flutchai/聊天核心) (中文(简体) ).
Browser (this package) ──► your backend (adds X-API-Key + userId) ──► api.flutch.ai
快开始
import { ChatProvider, Chat } from "@flutchai/chat-react";
import { createFlutchClient } from "@flutchai/chat-core";
import "@flutchai/chat-react/styles.css";
const client = createFlutchClient({
baseUrl: "/api/chat", // your backend's proxy
agentId: "67b88f7ec6092d7bc711a934",
credentials: "include", // if your proxy authenticates with a session cookie
});
export function Support() {
return (
<div style={{ height: 600 }}>
<ChatProvider client={client}>
<Chat showThreads />
</ChatProvider>
</div>
);
}
聊天会填充其父母,因此给父母一个高度. 它恢复了挂载上先前的对话( 当前线程 ID 保存在其中) localStorage; 通过 storage 改为 ChatProvider 以用别之.
他们
覆盖聊天元素或任何祖先上的变量 :
.my-chat {
--flutch-primary: #0a7a5a;
--flutch-on-primary: #fff;
--flutch-radius: 8px;
--flutch-font: "Inter", sans-serif;
}
| 变量 | 默认 | |
|---|---|---|
--flutch-primary 编号 : --flutch-on-primary | #4f46e5 编号 : #fff | 发送按钮、口音 |
--flutch-user-bg 编号 : --flutch-user-text | 小学/小学 | 你的用户的泡沫 |
--flutch-assistant-bg | --flutch-surface | 气泡剂 |
--flutch-bg, (中文(简体) ), --flutch-surface, (中文(简体) ), --flutch-text, (中文(简体) ), --flutch-muted, (中文(简体) ), --flutch-border | 光线 | 表面和文字 |
--flutch-danger, (中文(简体) ), --flutch-danger-bg | 红色 | 错误横幅 |
--flutch-radius, (中文(简体) ), --flutch-gap, (中文(简体) ), --flutch-font, (中文(简体) ), --flutch-font-size | 14px, (中文(简体) ), 12px系统, 15px | 形状和类型 |
--flutch-chart-1 . --flutch-chart-8 | 初级,然后是固定调色板 | 图表序列 |
暗模式跟随OS. 强制一号 <Chat theme="dark" />。 。 。 .
替换部件
import ReactMarkdown from "react-markdown";
<ChatProvider
client={client}
labels={ruLabels} // or your own strings
components={{
Markdown: ({ text }) => <ReactMarkdown>{text}</ReactMarkdown>,
Button: MyDesignSystemButton,
Message: ({ message }) => ( // wrap the default row
<div className="row"><MessageItem message={message} /></div>
),
}}
attachmentRenderers={{
product_link: ProductCard, // add or override by attachment type
}}
>
- 马克倒地. 默认显示为纯文本,所以没有减值依赖性,也没有任何东西可以消毒. 插进
react-markdown(默认情况下它逃脱了 HTML) 如果您的代理以标记下回答 。 不将代理文本向dangerouslySetInnerHTML。 。 。 . - 附录. 内建于:
image, (中文(简体) ),video, (中文(简体) ),audio, (中文(简体) ),voice, (中文(简体) ),file, (中文(简体) ),button(一个按钮或其中的一个阵列),suggestion, (中文(简体) ),citation, (中文(简体) ),card, (中文(简体) ),gallery, (中文(简体) ),article_link(成绩单:当值有url,否则只是标题,question财务报告和审定财务报表chart(见下文)。 其他类型(product_link, (中文(简体) ),checkout_link, (中文(简体) ),payment_link, (中文(简体) ),order_link, (中文(简体) ),recipe_card, (中文(简体) ),lead_form, deeplinks)没有默认,因为它们依赖于你的存储前缀:注册出成像器. 未知类型被跳过, 一个不正确的附件永远不会中断对话 。 所有来自代理的 URL 都经过safeUrl(仅限http, (中文(简体) ),https, (中文(简体) ),mailto, (中文(简体) ),tel和相对链接). - 出问. A 类
question附件作为一至四个问题的卡片: 单一或多个选择,加自由文本"其他",除非allowOther: false。答案会随用户的下一封信件一起发出,格式是代理机所期望的格式(选择的标签加入),页:1header: answer当有数个问题时,每行。 为更简单的客户端提供的回复按钮(metadata.fallbackFor: "question")被隐藏. 一旦用户在提问后写出任何内容,卡片就只读取,同样是在重新装入后.QuestionCard如果您想要在信件列表之外进行导出. - 图. A 类
chart附件( 编号)line, (中文(简体) ),area, (中文(简体) ),bar, (中文(简体) ),pie)被绘制为SVG,没有图表库. 条形图options.stacked财务报告和审定财务报表options.horizontal(与options.labelWidth); 数值格式化为options.currency, (中文(简体) ),options.percentage或者说options.unit; 网格隐藏showGrid: false,并且图例显示若干已命名的数据集或派(showLegend强迫它,无论方式。 覆盖一栏,指向或切片显示其值,这些值也列在屏幕阅读器的可视化隐藏表格中. 颜色来自数据集(仅来自平面颜色值)或--flutch-chart-*调色板。 图表沿用了信息泡的宽度. - 线索列表.
ThreadList以“显示更多内容”, 显示加载状态和空状态, 并标记正在生成回复的对话。 当服务器命名时, 对话会获得其标题( T)thread_renamed当回复降落时,移动到顶部。 过onSelect对抽屉的反应,例如关闭手机上的抽屉。 重命名和删除对话框尚未在 API 中 . - 布局图.
<Chat>这是一个方便。 编曲MessageList, (中文(简体) ),Composer, (中文(简体) ),ThreadList, (中文(简体) ),ErrorBanner财务报告和审定财务报表EscalationNotice用于其它布局,或读取状态useChat(selector)。 。 。 .
钩子
const messages = useChat(s => s.messages);
const store = useChatStoreApi();
store.getState().send({ text: "Hello" }); // programmatic send
完整状态和行动:见 ChatStore 内 @flutchai/chat-core。 。 。 .