@fv-ui/ai-chat 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -6
- package/dist/index.d.ts +177 -106
- package/dist/style.css +1 -1
- package/es/index.mjs +263 -77
- package/lib/index.js +262 -76
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -467,7 +467,9 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
467
467
|
|
|
468
468
|
### Conversations
|
|
469
469
|
|
|
470
|
-
会话列表(按 group 分组)。列表超长(>2×virtualThreshold)且显式传入 `virtual-disabled="false"`
|
|
470
|
+
会话列表(按 group 分组)。列表超长(>2×virtualThreshold)且显式传入 `virtual-disabled="false"` 时启用内部自滚虚拟滚动,按行高裁剪视口外行;缺省关闭——消费方把滚动交给外层容器(如 el-scrollbar)时根节点不滚动,scroll 事件永不触发,虚拟化会永久截断列表。启用须保证组件根自身可滚动(或 height 受限)。
|
|
471
|
+
|
|
472
|
+
滚动由外层共享容器接管时(如侧栏多实例平铺在一个 el-scrollbar 内),改用 `external-scroll` 外部滚动窗口化:消费方把容器 `scroll-top`/`viewport-height` 与本列表在容器内容中的偏移 `offset-top` 作为 props 下发,组件按相对视口位置裁剪窗口,根节点不自滚、以 spacer 撑满总高(保证共享容器内后续区块偏移稳定);`viewport-height` 未测量(0)时不渲染行,待消费方测量后下发。
|
|
471
473
|
|
|
472
474
|
| Prop | 类型 | 默认 | 说明 |
|
|
473
475
|
| --- | --- | --- | --- |
|
|
@@ -479,7 +481,11 @@ Markdown 渲染(Sanitized by DOMPurify),内置 Prism 代码高亮与 KaTeX。
|
|
|
479
481
|
| hasMore | boolean | false | 是否还有更早分页(缺省 false 不触发 load-more) |
|
|
480
482
|
| rowHeight | number | 32 | 行高(虚拟滚动按 行数×行高 计算总高与窗口) |
|
|
481
483
|
| virtualThreshold | number | 8 | 视口上下各多渲染的缓冲行数 |
|
|
482
|
-
| virtualDisabled | boolean | true |
|
|
484
|
+
| virtualDisabled | boolean | true | 内部自滚虚拟滚动开关(opt-in;缺省关闭。外部滚动容器接管时根节点不滚,scroll 永不触发,虚拟化会截断列表;启用须保证根自身可滚动) |
|
|
485
|
+
| externalScroll | boolean | false | 外部滚动窗口化:滚动由外层共享容器接管,窗口由 scrollTop/viewportHeight/offsetTop 驱动(优先于 virtualDisabled;spacer 撑满总高) |
|
|
486
|
+
| scrollTop | number | 0 | 外层滚动容器的 scrollTop(容器内容坐标系;仅 externalScroll) |
|
|
487
|
+
| viewportHeight | number | 0 | 外层滚动容器视口高度(仅 externalScroll;0=未测量,不渲染行) |
|
|
488
|
+
| offsetTop | number | 0 | 本列表在外层容器内容中的偏移(首条目距容器内容顶;仅 externalScroll) |
|
|
483
489
|
| locale | LocaleInput(string \| 对象) | undefined | 语言包:'zh-CN'/'en'/'ko'/'vi'/'zh-HK' 整包或部分文案对象(优先于祖先注入与全局设置) |
|
|
484
490
|
|
|
485
491
|
| Event | 说明 |
|
|
@@ -873,7 +879,7 @@ const sidebarRef = ref()
|
|
|
873
879
|
| service | FvAiSessionService | (必填) | 会话数据服务(宿主注入;archive 可选,未实现时隐藏归档 tab 与菜单项) |
|
|
874
880
|
| activeId | string | (必填) | 当前会话 id(草稿哨兵 DRAFT_SESSION_ID 或真实 id) |
|
|
875
881
|
| v-model:collapsed | boolean | false | 收起态(默认展开);收起态窄条竖排「展开 + 新建 + 搜索」三个图标按钮 |
|
|
876
|
-
| pageSize | number |
|
|
882
|
+
| pageSize | number | 30 | 列表分页大小 |
|
|
877
883
|
| searchable | boolean | true | 显示搜索框(后端标题模糊匹配,输入防抖 400ms,清空即恢复) |
|
|
878
884
|
| brandName | string | 'Gizmo' | 品牌名称 |
|
|
879
885
|
| brandIcon | string | 内置品牌头像 | 品牌徽章图片 URL(默认内置 fvai-avatar.svg) |
|
|
@@ -884,6 +890,7 @@ const sidebarRef = ref()
|
|
|
884
890
|
| searchHistoryEnabled | boolean | true | 是否启用搜索历史功能(点击选中搜索结果时才记录;localStorage 持久化,最多 10 条,去重) |
|
|
885
891
|
| searchHistoryKey | string | 'fv-ai-search-history' | 搜索历史 localStorage 存储 key(多实例/多业务场景可自定义隔离) |
|
|
886
892
|
| searchHistoryPinned | boolean | false | 搜索历史是否常驻弹窗底部(true 常驻;false 仅输入为空时展示在结果区上方) |
|
|
893
|
+
| showOperationError | boolean | false | 操作失败时是否弹出「操作失败」toast(默认 false:宿主经 axios 统一拦截并弹后端 message 时无需重复提示;无统一拦截时可设 true 兜底) |
|
|
887
894
|
|
|
888
895
|
| Event | 说明 |
|
|
889
896
|
| --- | --- |
|
|
@@ -1053,7 +1060,7 @@ Props 按用途分四组:
|
|
|
1053
1060
|
|
|
1054
1061
|
### AiChatWidget
|
|
1055
1062
|
|
|
1056
|
-
悬浮对话面板(FvAiChatWidget):Teleport 到 body,双形态——`drawer` 抽屉(默认:贴 position 侧全屏高,`offsetTop`/`offsetBottom` 各自留白)/ `floating` 悬窗(独立窗口,高度默认视口高 - 上下留白 - 80,可拖 header 自由移动,整窗限视口内不出界);宽度可经拖拽手柄调整(`minWidth`~`maxWidth`,默认 450~640px;抽屉仅内缘一个手柄,悬窗左右两缘均可调,拖左缘时窗口同步平移、右缘不动),拖拽落定经 localStorage 记忆(`storageKey` 自定义)。头部左侧「头像 + AI 名称」(默认内置品牌头像),右侧图标按钮均带 tooltip:「历史会话 + 新对话 + 模式切换 + 最大化 + 关闭」(模式切换按钮默认隐藏,`showModeToggle` 开启;隐藏时仍可拖 header 超 100px 转悬窗、悬窗贴边吸附回抽屉);点历史会话图标在对话区覆盖式下拉(层挂在 body 内,header 露出不遮挡;顶部「返回」工具条收层,内嵌 FvConversations:「今天/以往」分组 + hover 菜单重命名/删除 +
|
|
1063
|
+
悬浮对话面板(FvAiChatWidget):Teleport 到 body,双形态——`drawer` 抽屉(默认:贴 position 侧全屏高,`offsetTop`/`offsetBottom` 各自留白)/ `floating` 悬窗(独立窗口,高度默认视口高 - 上下留白 - 80,可拖 header 自由移动,整窗限视口内不出界);宽度可经拖拽手柄调整(`minWidth`~`maxWidth`,默认 450~640px;抽屉仅内缘一个手柄,悬窗左右两缘均可调,拖左缘时窗口同步平移、右缘不动),拖拽落定经 localStorage 记忆(`storageKey` 自定义)。头部左侧「头像 + AI 名称」(默认内置品牌头像),右侧图标按钮均带 tooltip:「历史会话 + 新对话 + 模式切换 + 最大化 + 关闭」(模式切换按钮默认隐藏,`showModeToggle` 开启;隐藏时仍可拖 header 超 100px 转悬窗、悬窗贴边吸附回抽屉);点历史会话图标在对话区覆盖式下拉(层挂在 body 内,header 露出不遮挡;顶部「返回」工具条收层,内嵌 FvConversations:「今天/以往」分组 + hover 菜单重命名/删除 + 触底分页,打开即拉取,点行切会话;service 实现文件夹方法(listFolders/moveSessions 等)时历史层自动切文件夹分组——文件夹行(图标/计数/三点菜单重命名/删除)+ 未分组平铺,会话可单条/批量移动到文件夹,与侧栏同口径);主体内嵌 FvAiChatPanel(常规态 welcomeLayout 固定 vertical、centerWelcome 固定 false 窄宽形态:欢迎页贴上、输入区贴底,建议列表为 FAQ 式行列表——行间细分隔线、行尾箭头指示、hover 底色对称淡入淡出)。**最大化**(`maximizable`,默认 true;关闭按钮左侧按钮,亦经 `toggleMaximize()` 编程式切换):inset 0 占满视口的覆盖态,退出后回到进入前的 drawer/floating 原形态;最大化态头部收敛(头像/标题/历史/新对话/模式切换隐藏,标识由侧栏品牌行承担,仅留还原/关闭;关闭面板即退出最大化,再开回常规形态),FvAiSessionSidebar 升为根级全高覆盖(选中/新建/删除/搜索/归档全能力,service/locale/品牌透传;默认收起为 44px 悬浮窄条、可展开 260px,对话区经 padding-left 让位/收回),Panel 欢迎页转横排 + 垂直居中,限宽三参回库默认 1160/1200/780px 聚焦中栏,建议列表转大屏胶囊横排;拖拽/调宽/头部按钮随态禁用。面板底带主色角部微光渐变(科技感,亮暗两态;暗色下透明度升档 + 边框调亮 + 投影加深,面板与同色系页面背景可分层)。会话编排收在内部:草稿哨兵起步、session-created 换真实 id 并刷历史列表、round-complete 延时 2.5s 刷列表。**关闭保活**(`keepAlive`,默认 true):关闭仅隐藏(v-show),实例/对话树原样保留,再开不重渲染、不重拉历史。
|
|
1057
1064
|
|
|
1058
1065
|
```vue
|
|
1059
1066
|
<script setup lang="ts">
|
|
@@ -1096,6 +1103,7 @@ const open = ref(false) // 两个 v-model 接同一 ref
|
|
|
1096
1103
|
| title | string | '' | 头部标题(空时回落 locale AI 名称) |
|
|
1097
1104
|
| avatar | string | 内置品牌头像 | 头部头像图片 URL |
|
|
1098
1105
|
| service | FvAiSessionService | (必填) | 会话数据服务(透传 Panel 与 Sidebar) |
|
|
1106
|
+
| showOperationError | boolean | false | 操作失败时是否弹出「操作失败」toast(默认 false:宿主经 axios 统一拦截并弹后端 message 时无需重复提示;无统一拦截时可设 true 兜底;透传 Sidebar) |
|
|
1099
1107
|
| adapter | ChatAdapter | (必填) | 聊天适配器(透传 Panel) |
|
|
1100
1108
|
| sessionId | string | '' | 当前会话 id(缺省内部 DRAFT 编排;传入则受控优先) |
|
|
1101
1109
|
| placeholder / suggestions / suggestionsTitle / suggestionsWrap / showRefreshSuggestions / refreshSuggestionsText / typing / collapsible / showTime / theme / locale / toolStepLabel | | | FvAiChatPanel 同名 props 透传 |
|
|
@@ -1178,6 +1186,23 @@ const open = ref(false) // 两个 v-model 接同一 ref
|
|
|
1178
1186
|
| default | 整体替换按钮内容(光晕层恒在,内容铺在光晕之上;存在时 #icon 不渲染) |
|
|
1179
1187
|
| icon | 覆盖按钮图标(默认内置品牌头像矢量图,圆形裁切铺满) |
|
|
1180
1188
|
|
|
1189
|
+
### FvAiFolderDialog(文件夹弹窗)
|
|
1190
|
+
|
|
1191
|
+
侧栏/悬浮窗历史层内部共用的文件夹弹窗,双形态:`name`(新建/重命名,输入框带 30 字上限与非空校验)与 `move`(会话移动,文件夹列表 + 关键字筛选,「未分组」恒在)。已公开导出,宿主可复用做同款交互。
|
|
1192
|
+
|
|
1193
|
+
| Prop | 类型 | 默认 | 说明 |
|
|
1194
|
+
| --- | --- | --- | --- |
|
|
1195
|
+
| visible | boolean | — | v-model:visible 显隐 |
|
|
1196
|
+
| mode | 'name' \| 'move' | — | 弹窗形态 |
|
|
1197
|
+
| title | string | 按 mode 取 locale | 标题(name 模式生效;move 恒用「移动到」) |
|
|
1198
|
+
| initialName | string | '' | name 模式回显值(重命名时传当前名) |
|
|
1199
|
+
| folders | FvAiFolder[] | [] | move 模式候选文件夹(未分组恒在列,不在此数组) |
|
|
1200
|
+
| locale | LocaleInput | undefined | 语言包 |
|
|
1201
|
+
|
|
1202
|
+
| Event | 说明 |
|
|
1203
|
+
| --- | --- |
|
|
1204
|
+
| confirm | name 模式:({ name });move 模式:({ folderId: string \| null })(null=移到未分组) |
|
|
1205
|
+
|
|
1181
1206
|
### FvAiSessionService(会话数据服务)
|
|
1182
1207
|
|
|
1183
1208
|
会话数据服务接口:宿主实现后经 prop 注入 FvAiSessionSidebar / FvAiChatPanel / FvAiChatWidget。库内不内置网络实现;错误提示(toast)由宿主胶水层统一承担(库对 service 失败:侧栏静默、面板空态重建)。
|
|
@@ -1191,8 +1216,9 @@ import type { FvAiSessionService, FvAiSessionPage, FvAiMessagePage } from '@fv-u
|
|
|
1191
1216
|
DRAFT_SESSION_ID // '__draft__'
|
|
1192
1217
|
|
|
1193
1218
|
interface FvAiSessionService {
|
|
1194
|
-
/** 会话列表(分页,updatedTime DESC;status 筛选与 keyword
|
|
1195
|
-
|
|
1219
|
+
/** 会话列表(分页,updatedTime DESC;status 筛选与 keyword 搜索正交同传;
|
|
1220
|
+
* folderId 三态过滤:不传/null=全部;0=仅未分组;>0=仅该文件夹) */
|
|
1221
|
+
list(q: { pageNum: number; pageSize: number; status?: 'ACTIVE' | 'ARCHIVED'; keyword?: string; folderId?: string | number | null }): Promise<FvAiSessionPage>
|
|
1196
1222
|
/** 新建会话,返回新会话 id */
|
|
1197
1223
|
create(): Promise<string>
|
|
1198
1224
|
/** 会话详情消息(尾部 limit 条,seq 升序) */
|
|
@@ -1219,6 +1245,19 @@ interface FvAiSessionService {
|
|
|
1219
1245
|
remove(sessionId: string): Promise<void>
|
|
1220
1246
|
/** 归档/恢复(可选;未实现时侧栏隐藏归档 tab 与菜单项) */
|
|
1221
1247
|
archive?(args: { sessionId: string; archived: boolean }): Promise<void>
|
|
1248
|
+
/** 文件夹列表(可选;createdTime 升序,ACTIVE 口径 sessionCount/ungroupedCount) */
|
|
1249
|
+
listFolders?(): Promise<FvAiFolderListResult>
|
|
1250
|
+
/** 新建文件夹(可选),返回 folderId;30016 重名 / 30018 超上限由宿主映射
|
|
1251
|
+
* (库内 locale 预留 duplicateFolderName/folderLimitExceeded 文案,宿主胶水
|
|
1252
|
+
* 可经 useLocaleDict 取用或自行映射错误码 toast) */
|
|
1253
|
+
createFolder?(name: string): Promise<string>
|
|
1254
|
+
/** 重命名文件夹(可选) */
|
|
1255
|
+
renameFolder?(args: { folderId: string; name: string }): Promise<void>
|
|
1256
|
+
/** 删除文件夹(可选;逻辑删,其中会话退回未分组,不级联删消息) */
|
|
1257
|
+
removeFolder?(folderId: string): Promise<void>
|
|
1258
|
+
/** 批量移动会话(可选;1~100,整体成败;folderId null/0=未分组)。
|
|
1259
|
+
* listFolders+moveSessions 均实现时侧栏启用文件夹模式(explorer 分组/CRUD/移动) */
|
|
1260
|
+
moveSessions?(args: { sessionIds: string[]; folderId?: string | null }): Promise<void>
|
|
1222
1261
|
/** 内容搜索(可选;未实现时侧栏自动降级为纯标题搜索) */
|
|
1223
1262
|
search?(q: { keyword: string; pageNum: number; pageSize: number }): Promise<FvAiSearchPage>
|
|
1224
1263
|
/** 以锚点为中心开窗(可选;定位锚不在 detail 窗口时由面板调用) */
|
|
@@ -1228,6 +1267,9 @@ interface FvAiSessionService {
|
|
|
1228
1267
|
// 归一化形状(宿主 IPage 格式由胶水转换)
|
|
1229
1268
|
interface FvAiSessionPage { items: FvCommonSessionItem[]; hasMore: boolean }
|
|
1230
1269
|
interface FvAiMessagePage { messages: FvCommonMessage[]; hasMore: boolean }
|
|
1270
|
+
// 文件夹(单层、用户私有)
|
|
1271
|
+
interface FvAiFolder { folderId: string; name: string; createdTime?: string; sessionCount?: number }
|
|
1272
|
+
interface FvAiFolderListResult { folders: FvAiFolder[]; ungroupedCount?: number }
|
|
1231
1273
|
```
|
|
1232
1274
|
|
|
1233
1275
|
宿主胶水示例(det-oms 风格:list/create/detail/history/rename/remove 转发到宿主 httpRequest,并把后端 IPage 归一化为 { items, hasMore };**错误 toast 由胶水层承担**):
|