orbcafe-layout-navigation

使用 CAppPageLayout、NavigationIsland、useNavigationIsland、i18n、markdown 渲染器和 CPageTransition 构建 ORBCAFE 应用外壳和导航

安装

概览

什么是orbcafe-layout-navigation

ORBCAFE Layout + Navigation 是一个专为现代 React 应用设计的 UI 框架,基于 Next.js App Router 架构构建。它采用 Hook-first 的设计理念,提供了一套完整的页面布局与导航解决方案,帮助开发者快速搭建结构清晰、体验流畅的应用外壳。该工具通过封装 CAppPageLayout、NavigationIsland、CPageTransition 等核心组件,实现了对国际化(i18n)、Markdown 渲染器和路由过渡动画的统一管理,显著降低前端架构的复杂度。其底层依赖 MUI 生态体系,集成了 @mui/material、@mui/icons-material 和 @mui/x-date-pickers 等成熟组件库,确保视觉一致性与交互可用性。整个系统强调运行时安全,内置 locale 切换、hydration 一致性保护和菜单高亮逻辑,避免 SSR 与 CSR 首帧渲染差异导致的白屏或闪烁问题。通过标准化的 providers 层配置,全局主题、本地化资源和消息提示得以集中管控,避免重复配置。整体设计遵循“约定优于配置”原则,鼓励使用官方示例中的 page/providers 骨架结构,提升开发效率与代码可维护性。

核心功能特点

  1. 采用 Hook-first 架构,以 useNavigationIsland 为核心实现响应式导航状态管理
  2. 内置 CAppPageLayout 壳层组件,自动处理 logo、菜单、用户入口及子内容注入
  3. 支持 CPageTransition 统一动效控制,默认 160-260ms 平滑过渡,仅用 transform/opacity 优化性能
  4. 集成 i18n 与 Markdown 渲染器,提供多语言切换与富文本内容展示能力
  5. 通过 Providers 层集中挂载 ThemeProvider、LocalizationProvider 和 GlobalMessage,避免重复配置
  6. 严格遵循 hydration 安全策略,usePathname 高亮逻辑采用 mounted 防抖机制防止 SSR/CSR 不一致

适用场景

ORBCAFE Layout + Navigation 特别适用于需要快速搭建企业级中后台系统的场景,如数据分析平台、内容管理系统或 SaaS 产品控制台。这类应用通常具有复杂的导航层级和多模块功能分区,而本工具提供的 full shell 模式能一键生成包含侧边栏、顶部导航和用户操作区的完整页面框架,大幅减少重复编码工作。对于国际化要求较高的项目,其内置的 locale 切换机制和 SSR 兼容方案可有效解决多语言环境下的渲染一致性问题。当业务页面需要嵌入 Markdown 文档或动态内容时,集成的渲染器组件可直接解析并安全渲染富文本,无需额外引入第三方库。在用户体验层面,CPageTransition 提供的标准化过渡效果确保了页面跳转时的流畅感,尤其适合数据看板类应用频繁切换视图的场景。此外,该工具对 hydration 问题的防御性处理,使得在复杂交互逻辑下仍能保持稳定的首屏表现,降低因客户端与服务端状态不同步引发的异常风险。无论是从架构规范还是工程实践角度,它都为企业级前端项目的标准化落地提供了可靠支撑。