@itick/chat-core
v1.0.1
Published
AI Chat SDK Core - ShadowDOM-based chat UI with style isolation
Readme
@itick/chat-core
iTick AI Chat SDK 核心库 — 基于 ShadowDOM 的聊天 UI 组件,提供完整的样式隔离、虚拟滚动、Markdown 渲染和流式 SSE 通信能力。
安装
npm install @itick/chat-core或者通过 CDN 直接引入:
<script src="https://unpkg.com/@itick/chat-core/dist/chat-core.umd.js"></script>
<script>
const sdk = new ChatSDK.ChatSDK({
apiUrl: 'https://agent.itick.org/agent/token/stream',
token: 'your-api-token',
container: document.getElementById('chat-container'),
});
sdk.mount();
</script>快速接入
import { ChatSDK } from '@itick/chat-core';
const sdk = new ChatSDK({
apiUrl: 'https://agent.itick.org/agent/token/stream',
token: 'your-api-token',
container: document.getElementById('chat-container'),
});
sdk.mount();主要 API
| 方法 | 描述 |
|------|------|
| mount() | 挂载并渲染 UI |
| unmount() | 卸载 UI,保留实例 |
| destroy() | 彻底销毁实例 |
| sendMessage(content) | 发送消息 |
| clearMessages() | 清空消息 |
| getMessages() | 获取消息列表 |
| setHistoryMessages(msgs) | 设置历史消息 |
| updateConfig(partial) | 动态更新配置 |
| registerPlugin(plugin) | 注册渲染插件 |
| on(event, handler) | 监听事件 |
| off(event, handler) | 移除事件监听 |
消息渲染插件
sdk.registerPlugin({
name: 'my-plugin',
match: (msg) => msg.content.includes('**'),
render: (msg) => {
const el = document.createElement('div');
el.innerHTML = msg.content;
return el;
},
update: (el, msg) => {
el.innerHTML = msg.content;
},
});License
MIT
