Files
apes-sidebar/src/client/wco.ts
T
Atlas Zeng 50a888845f feat(sidebar): 桌面兼容三方案——自动检测(WCO 标准几何)/壳预设/自定义 CSS (#284)
* feat(sidebar): 桌面兼容三方案——自动检测(WCO 标准几何)/壳预设/自定义 CSS

核心只保留 Web 标准机制,壳专属适配全部下沉到用户空间(KISS):
- prefs 新增 titleBarScheme(默认 auto)/titleBarPresetId/customCss,旧 titleBarCompat
  布尔自动迁移(true→custom 保留 stripPx,false/缺失→auto)
- wco.ts:navigator.windowControlsOverlay 反应式几何(geometrychange 实时更新;
  visible=false 的幽灵 API 视为缺失),实现 #257
- titlebar-strip.ts 唯一 strip 取值链:WCO → dsh-desktop-titlebar-inset 契约参数
  → 预设 stripFor → 手动 px → 0;desktop-env.ts 移除 win32 32px 硬编码
- shell-presets.ts 数据驱动预设(准入:issue/PR 提及 + 100+ star;v1 仅
  anywhere-labs DSH Desktop:darwin 20px / win32 无 WCO 时 32px),opt-in 手动
- 预设/自定义 CSS 注入(data-dsh-preset-css / data-dsh-custom-css 标签),
  chrome 补稳定寻址面 data-dsh-toggle-cluster / data-dsh-panel
- 交互 chrome 统一 -webkit-app-region: no-drag(吸收 #111/#153)
- layout.css 底栏推挤复合锚点([data-pane] 与 :has(> [data-slot]) 双保险,
  rc.8 实测前者失效、后者命中,吸收 #226 思路)
- 设置 UI:位置兼容模式齿轮弹窗改三方案(自动检测/壳兼容方案/自定义方案)
- 测试:wco/titlebar-strip/shell-presets 单测 + prefs 迁移 + e2e 5 场景
  (保守 auto/WCO 反应式/预设/自定义 CSS/复合锚点),挂载门禁 12/12 全绿

核心 grep 无壳专属类名;为某壳做的兼容在另一壳会再坏——预设与自定义 CSS
是唯一出路(AGENTS.md §8 契约已更新)。

* refine(sidebar): 位置兼容模式改主行下拉四选项——自动检测/DSH官方Web/壳预设/自定义

按用户反馈定稿 UI:
- 主行下拉:自动检测(默认)/ DSH官方Web(显式零适配,连 WCO 也强制 0)/
  各壳预设(命中环境带「已检测」后缀,仅提示)/ 自定义方案(保留齿轮弹窗:
  下移距离 + 自定义 CSS)
- 旧文档迁移:titleBarCompat=true 或 titleBarStripPx 非默认值(此前已有配置)
  → 默认落到 custom 方案保留用户数值;干净文档 → auto
- prefs 新增 'web' 方案;strip 取值链最优先处理 web→0
- 测试:prefs 迁移(stripPx 48→custom / 40→auto)、web 强制 0、下拉渲染断言
- 单测 693 通过,挂载 e2e 12/12 全绿

* refine(sidebar): 方案下拉复用 SelectMenu 组件,不用原生 <select>

- 抽出可复用 SelectMenu(primitives Menu:锚点按钮 + 下拉选项卡,支持
  icon/desc/多选),SelectRow 改为其薄壳
- 位置兼容模式方案下拉改用 SelectMenu;选项带描述(自动检测/DSH官方Web/
  各壳预设(命中带「已检测」后缀)/自定义方案)
- 移除原生 select 样式;单测 693 通过,挂载 e2e 12/12 全绿
2026-08-21 01:28:17 +08:00

121 lines
4.3 KiB
TypeScript

/**
* Reactive Window Controls Overlay geometry — the STANDARD web mechanism
* for frameless Chromium shells that draw the native caption buttons
* (minimize / maximize / close) OVER the web content (Electron
* `titleBarOverlay` on Windows; issue #257). Feature-detected: absent in
* plain browsers, macOS, Tauri etc., where the snapshot stays `NONE` and
* the sidebar adapts nothing — this is the conservative "auto" signal.
*
* The API reports the real titlebar rect (CSS px), which differs between
* shells and Electron versions (32 / 36 …), and fires `geometrychange`
* when the window maximizes / restores / moves — so the strip must be
* reactive, not memoized like the URL stamps.
*
* Module-level store so the Sidebar shell can subscribe via
* `useSyncExternalStore`; `setWcoSourceForTests` swaps the source for unit
* tests (no real API exists in jsdom/headless).
*/
export interface WcoSource {
readonly visible: boolean
getTitlebarAreaRect(): { readonly x: number; readonly y: number; readonly width: number; readonly height: number }
addEventListener(type: 'geometrychange', listener: () => void): void
removeEventListener(type: 'geometrychange', listener: () => void): void
}
/** The current overlay geometry (present=false = API unavailable). */
export interface WcoSnapshot {
readonly present: boolean
readonly height: number
}
/** Snapshot when the API is unavailable (plain browser / non-overlay shell). */
export const WCO_NONE: WcoSnapshot = Object.freeze({ present: false, height: 0 })
type Listener = () => void
let source: WcoSource | undefined
let snapshot: WcoSnapshot = WCO_NONE
let attached = false
let sourceListener: (() => void) | undefined
const listeners = new Set<Listener>()
function read(): WcoSnapshot {
if (source === undefined) return WCO_NONE
try {
// A present-but-NOT-visible API is a PHANTOM: headless Chromium and
// macOS builds expose the interface but draw no overlay (empty rect,
// visible=false). Only a genuinely visible overlay is authoritative —
// otherwise the resolution chain would trust a zero rect and silently
// skip the shell's real reserved space.
if (source.visible !== true) return { present: false, height: 0 }
const rect = source.getTitlebarAreaRect()
const height = Math.round(rect.height)
return Number.isFinite(height) && height > 0
? { present: true, height }
: { present: true, height: 0 }
} catch {
// A hostile/racy API must never break the layout — treat as absent.
return { present: false, height: 0 }
}
}
function onGeometryChange(): void {
snapshot = read()
emit()
}
function emit(): void {
for (const listener of listeners) listener()
}
/** Attach the native geometrychange listener (once). */
function attach(): void {
if (attached) return
attached = true
// The test hook may have installed a source already; otherwise attach to
// the real navigator API (absent in plain browsers → stay NONE).
const candidate = source ?? (navigator as unknown as { windowControlsOverlay?: WcoSource }).windowControlsOverlay
if (candidate === undefined) return
source = candidate
sourceListener = onGeometryChange
snapshot = read()
source.addEventListener('geometrychange', sourceListener)
}
/** Detach the native listener (last subscriber left or source swapped). */
function detach(): void {
if (source !== undefined && sourceListener !== undefined) {
source.removeEventListener('geometrychange', sourceListener)
}
sourceListener = undefined
attached = false
}
/** Read the current snapshot (returns the frozen NONE when unavailable). */
export function getWcoSnapshot(): WcoSnapshot {
return snapshot
}
/**
* Subscribe to overlay geometry changes. Attaches to the real
* `navigator.windowControlsOverlay` on first subscribe; the disposer
* detaches the native listener when the last subscriber leaves.
*/
export function subscribeWco(onChange: Listener): () => void {
listeners.add(onChange)
attach()
return () => {
listeners.delete(onChange)
if (listeners.size === 0) detach()
}
}
/** Test hook: swap the geometry source (undefined = API unavailable). */
export function setWcoSourceForTests(next: WcoSource | undefined): void {
detach()
source = next
snapshot = next === undefined ? WCO_NONE : read()
if (next !== undefined && listeners.size > 0) attach()
emit()
}