@ cuttlely/聊天时
1.7.2包与1.7.2服务器相匹配. 仍然适用1.7.0安全例外升级要求:在服务器升级前备份数据库,加密密钥和设置. 读取 升级警告。只有指定的实例运算符可以更改服务设置,执行则默认停止。 在主机仪表板上读取主机-日志证明或Docker/Confose日志. 服务器升级需要 操作员登入和回收;只有经核实的主机绑定外公;遗留在服务器设置中安装有主机-日志代码的主张. 常规操作员生命周期在面板中;CLI是紧急恢复. 公共嵌入物仍与私人服务器侧API密钥相分离. 永远不要让一个特权持有人在浏览器嵌入配置中.
聊天流程或代理流程的聊天部件 。 它使阴影根内部,流出答案, 并且只与你的可爱的服务器交谈.
您的服务器也服务于此架构 /embed/chat.js,使部件保持与服务器相同的版本。 当应用程序导入部件时安装此软件包 .
npm install @cuttlely/chat
脚本标签
服务于你的可爱服务器。 脚本使用自己的地址作为服务器.
<script src="https://your-cuttlely.example.com/embed/chat.js" data-flow-id="YOUR_CHATFLOW_ID" defer></script>
标签所在的全页聊天:
<cuttlely-chat
flow-id="YOUR_CHATFLOW_ID"
mode="page"
api-host="https://your-cuttlely.example.com"
style="display:block;height:100vh"
></cuttlely-chat>
<script src="https://your-cuttlely.example.com/embed/chat.js" defer></script>
软件包文件是 dist/chat.js (单位:千美元)@cuttlely/chat/chat.js) (中文(简体) ). 当文件未从您的 Cuttle 服务器上装入时, 设置 data-api-host 到服务器.
| 属性 | 数值 | 默认 |
|---|---|---|
flow-id 编号 : data-flow-id | 聊天流程或代理流程 | 所需经费 |
mode 编号 : data-mode | bubble, (中文(简体) ), page | bubble |
theme 编号 : data-theme | auto, (中文(简体) ), light, (中文(简体) ), dark | auto |
api-host 编号 : data-api-host | 剪切服务器 URL | 脚本自己的服务器 |
open 编号 : data-open="true" | 开始打开 | 关闭 |
无害环境管理
import { mount } from '@cuttlely/chat'
const chat = mount(document.querySelector('#chat'), {
flowId: 'YOUR_CHATFLOW_ID',
apiHost: 'https://your-cuttlely.example.com',
mode: 'page',
theme: 'auto'
})
chat.open()
chat.close()
chat.reset()
chat.destroy()
flowId 需要时间. mode 实值 bubble 或者说 page。 。 。 . theme 实值 auto, (中文(简体) ), light 或者说 dark。 。 。 . apiHost 这是你的可爱的服务器。 脚本标签 window.cuttlelyChat.mount(element, options) 选择相同.
在嵌入前让聊天流公开. 需要 API 密钥的流程显示“ 此聊天是私人的或需要密钥 ” 。 流外允许域的站点显示"此聊天在此站点上无法使用".
开发
pnpm --dir packages/chat-widget build # dist/chat.js and dist/index.mjs
pnpm --dir packages/chat-widget test
dist/chat.js 是服务器服务的脚本 . dist/index.mjs 是ES模块. index.d.ts 是类型声明.