用途:settings-flow 是 OrcaQ 的设置开发指南,用于指导开发者在该项目中新增、更新和移除设置项,覆盖完整的“类型 → 常量 → store → 组件”四层数据流。
主要能力:文档说明了设置架构的四层结构:types/settings.types.ts 定义形状或枚举,constants/settings.constants.ts 保存默认值与 UI 选项数组,core/stores/appConfigStore.ts 提供响应式状态与重置动作(自动持久化),components/modules/settings/ 下的面板负责读写 store。它还列出各文件位置,并给出新增设置、新增设置面板标签页、更新已有设置、程序化打开设置的具体步骤,以及设置行的标准 UI 模式和关键约束。
使用方式:新增设置需依次修改类型、常量默认值、store 字段及重置动作,再在对应 *Config.vue 中补充 UI;新增面板标签页需添加 SettingsComponentKey 枚举值、SETTINGS_NAV_ITEMS 导航项、创建组件、在 SettingsContainer.vue 注册并从 components/index.ts 导出。程序化打开设置使用 core/contexts/useSettingsModal.ts 的 openSettings,标签名须与 SETTINGS_NAV_ITEMS 的 name 一致;全局快捷键为 Cmd+, / Ctrl+,。
适用场景:适用于 OrcaQ 项目内维护设置面板、扩展配置项或新增设置分区的开发工作。
限制:文档要求不得直接调用 localStorage,store 用 persist: true 自动持久化;默认值必须放在 constants/ 而非 store 或组件内联;重置动作须对响应式对象使用 Object.assign;components/ 下一般不导入 store,设置面板为例外;禁用导航项使用 disable: true 且无需 componentKey;重命名字段需迁移,否则旧持久化值会被忽略并在下次加载时应用新默认值。文档未提供 OrcaQ 的安装方式、许可证、价格或运行环境要求。