Back to marketplace

dsh-ui-state

UI & Experience

zink-ning-lkr/dsh-ui-state

Persists DSH Web GUI state such as sidebar collapse/width, details panel, and conversation scroll position across restarts.

  • dsh
  • dsh-plugin
  • dsh-plugins
GitHub Stars
2GitHub
Views
0DSH Plugin Hub
Forks
0GitHub
Open issues
0GitHub Issues
Manifest version
0.2.0@zink-ning-lkr/dsh-ui-state
Latest push
Aug 26, 2026GitHub
License
MITJavaScript
Plugin type
Host + ClientRuns in both Host and Web Client

README

View source

dsh-ui-state

界面状态持久化插件(DSH Web GUI)——官方侧边栏与详情面板跨重启恢复。

功能

  • 侧边栏开合:展开/收起状态自动持久化,重启 DSH 后自动恢复。
  • 侧边栏宽度:拖拽后的宽度自动持久化,重启后模拟拖拽恢复到上次宽度(264–420px 官方契约范围)。
  • 详情面板(details 列)开合:右侧详情面板的打开/关闭自动持久化并恢复(仅在会话打开时记录,避免把"无会话"误判为用户关闭)。
  • 对话滚动位置:切走/隐藏页面时保存当前对话的非底部阅读位置;视图因重连/重建回到顶部后自动恢复到切走前的位置(按消息 anchor 对齐,新消息追加也不会偏)。
  • 无需配置:全自动,无设置界面。

原理

官方 layout store 是瞬态设计(宽度/开合不持久化)。插件:

  1. 检测(事件驱动):MutationObserver 监听 AppFrame 的 data-sidebar-collapsed / data-details-collapsed 属性与 grid-template-columns(style),ResizeObserver 监听视口(窄屏判定);变化防抖 600ms,聚合为单次批量 mutate 写入 settings.yaml。 另保留 60s 安全兜底轮询,兜住观察者漏网的 DOM 替换 / portal 重渲染。
  2. 恢复:settings 就绪 / 框架挂载 / 会话流挂载等事件触发(600ms 重试链,最多 6 次, 事件可重新武装):
    • 侧边栏开合:调用官方 ctx.layout.toggleSidebar()(等 layout 服务挂载后自动重试)
    • 侧边栏宽度:找到 [data-side="sidebar"] 拖拽手柄,派发合成 pointer 序列(pointerdown/move/up, 与官方 DragHandle 的监听协议一致;同步窗口内 stub pointer capture)
    • 详情面板:ctx.layout.openDetails() / closeDetails()(仅在会话打开时恢复)
  3. 窄屏保护:视口 < 1024px 时官方自动折叠侧边栏,此时不持久化、不恢复,避免与自动行为打架。
  4. 卸载保护:pagehide / freeze / 页面隐藏时同步落盘(fetch 带 keepalive), 600ms 防抖窗口内关闭页面也不会丢最后一次操作。

性能

  • 零空闲轮询:状态读取由事件驱动,空闲时无周期任务;60s 安全兜底仅兜异常路径。 相对旧版 400ms 轮询,空闲开销从 2.5 次 DOM 扫描/秒降为 0。
  • 批量写入:一次折叠/宽度/详情变更合并为 1 次 mutate POST(旧版最多 3 次), revision 乐观锁只校验一次。
  • 观察者收窄:会话区变更只检查新增节点;滚动恢复按 (scrollport, session) 实例 只执行一次,聊天流渲染期间不重复扫描。

配置存储

ui-state:
  sidebarCollapsed: false   # 用户显式折叠后为 true
  sidebarWidth: 360         # 最近一次展开宽度
  chatScroll:               # 按会话保存的非底部阅读位置(自动维护,可手删)
    "<sessionId>":
      anchorKey: "..."
      anchorTop: 120
      scrollTop: 480
      updatedAt: 1750000000000

兼容性

当前宿主目标 DSH 0.1.0-rc.8,同一 0.1.x 版本线的最新 0.1.1-rc.2 同样覆盖 (已逐 seam diff:settings 字节一致,layout/conversation/webserver/connection/runtime 契约零漂移,loader/include 装配机制不变)。依赖范围故意写成双线 >=0.1.0-rc.8 <0.2.0 || >=0.1.1-rc.0:npm 的 prerelease「同元组」规则使 ^0.1.0-rc.8 并不包含 0.1.1-rc.2,双线范围可让宿主升级后 npm 去重为同一份 dsh-settings 实例(避免双实例导致的 SettingsConflictError instanceof 失效)。 实现基于能力探测与事件驱动,不绑定具体 rc 细节,跨版本漂移时以兜底分支降级。 0.2.0 起已逐项核对 rc.8 组合,本插件用到的官方契约全部原样保留:

  • settings 接缝@deepseek-ai/dsh-settings(双线范围,见上),register / describe / mutate(含 SettingsConflictError 冲突拒绝与 revision 乐观锁)不变。
  • webServer 路由register({ kind: "exact", path, handler }) 签名不变。
  • layout 服务ctx.layout.toggleSidebar() / openDetails() / closeDetails() 与 AppFrame 的 data-sidebar-collapsed / data-details-collapsed / grid-template-columns 契约不变;拖拽手柄 [data-side="sidebar"](展开时才渲染)、 窄屏 1024px 自动折叠同样保留。
  • DOM 锚点[data-shell-overlay](AppFrame 直接子节点)、[data-chat-flow][data-chat-anchor-key][data-conversation-scroll][data-composer-seat] 在官方会话视图原样保留(官方自身滚动恢复同用这套锚点)。
  • client 通道window.__ModuleLoader__.load 包格式、sessions.list.getSnapshot() .currentconnection.isLoopback 探针均不变。
  • 兼容性核对中发现 dsh-settings 的 rc.6 与 rc.8 各 JS 文件字节一致,因此旧 rc.6 宿主同样可用;依赖线仍升级到 ^0.1.0-rc.8 以对齐 rc.8 生态并防未来漂移。

安装 / 下载

从 npm 安装(推荐)

dsh plugin --profile web add @zink-ning-lkr/dsh-ui-state

也可以手动安装依赖并装配:

npm install @zink-ning-lkr/dsh-ui-state

然后在 profile 的 package.json 中把 @zink-ning-lkr/dsh-ui-state 加入 dsh.profile.bundles

从 GitHub Release 下载

Releases 下载 dsh-ui-state-0.2.0.tgz,然后安装:

dsh plugin --profile web add ./dsh-ui-state-0.2.0.tgz

本地开发 / 热装

profile package.jsondsh.profile.bundles 加入 @zink-ning-lkr/dsh-ui-state,依赖用 link: 指向本目录; 或使用 dev_install_package 热装(junction + loader.create,免重启)。

License

MIT © zink-ning (zink_ning)

关联

better-sidebar 等插件把状态存浏览器 localStorage——localStorage 按「域名+端口」隔离, DSH 启动端口随机(--port 0)时每次重启都会丢失。配套修复:DSH Desktop 源码 (D:\Code\dsh-desktop\main.js)已支持从 config.json 读 port 字段,把 %APPDATA%\DSH Desktop\config.json"port" 固定为 13372 后,localStorage 状态 (含 better-sidebar 的面板布局)跨重启稳定。

结构

  • lib/index.js — Node half:注册 ui-state settings namespace + loopback 桥接路由 (makeBridgeHandlers / makeBridgeRoutes 导出供测试)。
  • lib/client.js — 浏览器 half:事件驱动的状态持久化 + 开合/宽度/滚动恢复。
  • tests/bridge.test.mjs — 桥接单测(node --test tests/)。

Comments

0
Newest first