Skip to content

dsh-layout-presets

Verified

@shellraining/dsh-layout-presets · v0.1.3 · MIT · Web UI

DSH 右栏比例预设、窗口缩放时保持比例和双击分割线等分

Install

dsh plugin add @shellraining/dsh-layout-presets

Confirm the layer applied with dsh --profile default --dump-config — see the install guide.

Source

Published to npm without a public repository. Inspect the package contents before installing.

Tags

Readme

dsh-layout-presets

让对话区与右侧工作区面板按比例分配宽度。这里的右栏是包含文件、浏览器和终端的整个区域,不是左侧会话栏,也不是右栏内部的分栏。

使用

  • 首次启用默认保持 1:1。比例按扣除左侧会话栏后的可用宽度计算。
  • 拖动对话区与右栏之间的分割线时,在 1:2、1:1、2:1 的目标位置显示参考线,比例顺序为“对话区 : 右栏”。标签位于指针上方,松手后隐藏,不再常驻右下角。
  • 距离预设位置 8px 内吸附并高亮参考线,继续拖到距离目标超过 22px 即可脱离。窗口宽度不足以达到的预设不显示、不吸附;其余位置可自由拖动。
  • 参考线和标签使用 DSH 的颜色、字体、阴影 Token,以及 Win10 风格的小圆角和细边框,不依赖 Fluent 主题插件。
  • Escape、窗口失焦或取消指针操作会取消本次拖动,恢复之前保存的比例;拖动过程中调整窗口大小也会取消本次拖动。
  • 双击对话区与右栏之间的原生分割线,恢复 1:1。
  • 手动拖动这条分割线后,记住新的比例。点击但未拖动不会覆盖选择。
  • 调整窗口大小或展开、收起左侧会话栏时,继续保持目标比例。
  • 选择保存在当前浏览器源的 localStorage 中,刷新后沿用,同源窗口同步。存储不可用时仍可使用,但只能保持到当前页面关闭。
  • 关闭右栏、切换到右栏全屏或离开有右栏的页面时暂停,不主动打开面板。恢复普通右栏后重新应用比例。

卸载或停用插件会移除控件、样式、订阅和事件监听,不把宽度强制恢复到启用前的值;宿主保留最后一次宽度。保存的比例不会删除。

安装

dsh plugin --profile web add @shellraining/dsh-layout-presets

web 是独立 Web profile 名称。安装后刷新当前 DSH 页面。Electron 的 desktop profile 由桌面应用管理,普通 CLI 不可直接操作;使用应用内插件管理器,或退出桌面应用后使用随应用分发的 Desktop CLI。

本地开发

在仓库根目录安装依赖并构建:

pnpm install
pnpm --filter @shellraining/dsh-layout-presets typecheck
pnpm --filter @shellraining/dsh-layout-presets build

需要加载到自己的 profile 时,自行执行以下命令,将路径替换为本仓库中子包的绝对路径:

dsh plugin --profile web add /absolute/path/to/dsh-plugins/plugins/layout-presets

这里的 web 是独立 Web profile 名称。桌面应用使用上文的 Desktop CLI 管理方式,不能只把普通 CLI 命令中的 profile 改成 desktop。安装后重新打开桌面应用或刷新 Web 页面,并确认加载的是本次构建目录。单纯构建不会把插件安装到现有页面;插件自身不修改用户安装配置、不启动另一套 Web 服务。

源码使用严格 TypeScript。构建入口调用仓库共享 Vite 适配,生成 lib/index.js 和通过 ModuleLoader 注册的 lib/client.js。客户端没有自带 React 运行时,也不依赖其他社区插件。

已知限制与兼容性

实现依据是 @deepseek-ai/dsh-client-ui-layout 的 0.2.1-rc.3。包中的 DSH 版本范围只限制安装候选,不保证范围内所有版本都兼容。

宿主尚未公开宽度设置接口,本包通过注入的 layout 服务调用非公开方法。兼容边界集中在 src/host.ts:

依赖 用途与风险
ctx.layout.panels.setRightbar(px) 更新宿主宽度偏好,保持面板内容、轨道和拖拽手柄同步。私有属性改名或方法语义变化会影响插件。
ctx.layout.panelInfo.subscribe(listener) 当前实现订阅整个布局 store,窗口测量、面板开关等变化会触发通知。如果上游缩小订阅范围,需要重新核对通知是否足够。
data-rightbar-col、data-shell-overlay、data-side="rightbar" 定位唯一的三栏框架与外侧拖拽手柄,不依赖带 hash 的类名。属性或层级变动可能导致插件暂停。
三条 CSS 网格轨道及 data-rightbar-collapsed、data-rightbar-fullscreen、data-dragging、data-animating 测量剩余宽度,避开关闭、全屏、手拖和开合动画。宿主更换布局模型时需适配。
中栏 400px、右栏 300px、右栏最多视口 70% 沿用当前宿主约束。窄窗口无法严格维持预设比例,但不会用实际受限宽度覆盖目标比例。

没有所需服务方法时,插件停用并在控制台告警;找不到唯一框架、手柄或预期网格结构时暂停写入。宽度方法抛错时清理插件资源,不接管原生拖动。方法仍存在但行为改变的情况无法仅靠能力检查完全识别。

其他限制:

  • 窗口过窄时,宿主可能主动关闭右栏;窗口变宽后需手动重新打开。本包不改变这个行为。
  • 参考线是仅拖动时显示的独立浮层,不拦截指针。插件在捕获阶段接管右栏分割线的指针拖动,通过宿主宽度 API 更新布局,避免宿主拖动和吸附同时写入宽度;停用后恢复宿主原生拖动。当前未增加键盘调整宽度的入口。
  • 比例按当前宿主 CSS 网格轨道计算,不按屏幕物理像素计算。整体缩放插件若改变宿主测量或定位模型,需要一起检查。
  • 不建议同时启用另一个自动设置外侧右栏宽度的插件,两者可能互相覆盖。
  • 本包保存的是整个框架共用的一份比例,不是每个会话一份。

上游已有右栏宽度 API 提案。正式接口可用后,应优先迁移,移除对私有 panels 的依赖。

升级检查

后续定期巡检可关注上游 packages/client/ui-layout 的布局服务、store、AppFrame 和列宽计算,以及 ui-sidebar-right 的开关和全屏呈现。重点检查上表的接口、属性、三栏结构与宽度限制是否变化。本包不自动创建巡检任务,也不自动更新或安装版本。

人工验收应在实际 DSH 页面中完成:

  1. 打开文件、浏览器或终端,拖动分割线靠近三个预设,确认参考线位置、吸附和脱离手感;松手后确认比例保持、参考线隐藏。
  2. 改变窗口宽高、展开和收起左栏,确认比例保持;窄窗口下确认宿主最小宽度和关闭行为未被破坏。
  3. 拖动后缩放窗口,确认新比例保持;双击分割线确认恢复等分。
  4. 刷新、切换会话、关闭并重开右栏、进入和退出全屏,确认恢复目标比例但不擅自打开右栏。
  5. 在明暗主题及中英文界面下检查参考线;拖动中按 Escape、切出窗口、关闭右栏,确认取消与清理;停用插件后确认参考线消失、原生拖动仍可用。

类型检查和构建不能替代以上页面验收。

许可

MIT