refactor: 优化代码结构,添加中文注释,完善 README 文档

- Hooks/组件添加 useMemo 优化,减少不必要的重计算
- 简化 TokenUsageDashboard 的 Suspense 嵌套层级
- 完善 README: 技术栈、构建产物位置、架构说明
This commit is contained in:
2026-01-21 20:15:34 +08:00
parent a77fcdd3dc
commit 13a873ec76
17 changed files with 944 additions and 365 deletions

View File

@@ -1,42 +1,70 @@
/**
* OpenBridge 主题管理 Hook
*
* 管理 data-obc-theme 属性,支持 day/dusk/night/bright 四种主题
* 主题选择会持久化到 localStorage
* 管理 data-obc-theme 属性,支持 day/dusk/night/bright 四种主题
* 主题选择会持久化到 localStorage
*/
import { useCallback, useEffect, useState } from 'react'
/** 支持的 OpenBridge 主题类型 */
export type ObcTheme = 'day' | 'dusk' | 'night' | 'bright'
/** 主题列表,用于循环切换 */
const THEMES: readonly ObcTheme[] = ['day', 'dusk', 'night', 'bright'] as const
/** localStorage 存储键名 */
const STORAGE_KEY = 'obc-theme'
/** 默认主题 */
const DEFAULT_THEME: ObcTheme = 'day'
/**
* 类型守卫:检查值是否为有效的主题
*
* @param value - 待检查的值
* @returns 是否为有效主题
*/
const isValidTheme = (value: unknown): value is ObcTheme =>
typeof value === 'string' && THEMES.includes(value as ObcTheme)
/**
* 获取初始主题(从 localStorage 或默认值)
*
* @returns 初始主题值
*/
const getInitialTheme = (): ObcTheme => {
if (typeof window === 'undefined') {
return DEFAULT_THEME
}
// SSR 环境下使用默认主题
if (typeof window === 'undefined') return DEFAULT_THEME
const stored = localStorage.getItem(STORAGE_KEY)
if (stored && ['day', 'dusk', 'night', 'bright'].includes(stored)) {
return stored as ObcTheme
}
return DEFAULT_THEME
return isValidTheme(stored) ? stored : DEFAULT_THEME
}
/**
* 管理 OpenBridge 主题切换
*
* @returns 主题状态和控制函数
*
* @example
* ```tsx
* const { theme, setTheme, cycleTheme } = useTheme()
*
* // 设置为夜间模式
* setTheme('night')
*
* // 循环切换到下一个主题
* cycleTheme()
* ```
*/
export const useTheme = () => {
const [theme, setThemeState] = useState<ObcTheme>(getInitialTheme)
// 应用主题到 DOM
// 应用主题到 DOM 并持久化
useEffect(() => {
if (typeof document !== 'undefined') {
document.documentElement.setAttribute('data-obc-theme', theme)
localStorage.setItem(STORAGE_KEY, theme)
}
if (typeof document === 'undefined') return
document.documentElement.setAttribute('data-obc-theme', theme)
localStorage.setItem(STORAGE_KEY, theme)
}, [theme])
// 切换到指定主题
@@ -46,18 +74,12 @@ export const useTheme = () => {
// 循环切换主题
const cycleTheme = useCallback(() => {
const themes: ObcTheme[] = ['day', 'dusk', 'night', 'bright']
const currentIndex = themes.indexOf(theme)
const nextIndex = (currentIndex + 1) % themes.length
const nextTheme = themes[nextIndex]
if (nextTheme) {
setThemeState(nextTheme)
}
}, [theme])
setThemeState((current) => {
const currentIndex = THEMES.indexOf(current)
const nextIndex = (currentIndex + 1) % THEMES.length
return THEMES[nextIndex] ?? DEFAULT_THEME
})
}, [])
return {
theme,
setTheme,
cycleTheme,
}
return { theme, setTheme, cycleTheme } as const
}