From 82511cf6f52b5c902f566ccde62f3fcd976c3084 Mon Sep 17 00:00:00 2001 From: XiaoDaiGua-Ray <51957438+XiaoDaiGua-Ray@users.noreply.github.com> Date: Thu, 5 Nov 2026 11:31:13 +0800 Subject: [PATCH] feat(navigation): group example menus and fix tab scroll arrows --- README.md | 2 +- README.zh-CN.md | 2 +- __test__/router/config.spec.ts | 25 +++- apps/admin/src/documentation-example.tsx | 19 ++- .../src/layout/components/MenuTag/index.tsx | 16 +- apps/admin/src/locales/lang/en-US/menu.json | 20 ++- apps/admin/src/locales/lang/zh-CN/menu.json | 20 ++- apps/admin/src/router/modules/demo/assets.ts | 37 +++++ apps/admin/src/router/modules/demo/axios.ts | 18 --- apps/admin/src/router/modules/demo/barcode.ts | 19 --- .../src/router/modules/demo/cache-demo.ts | 16 -- .../src/router/modules/demo/components.ts | 82 ++++++++++ .../src/router/modules/demo/context-menu.ts | 15 -- .../src/router/modules/demo/directive.ts | 19 --- apps/admin/src/router/modules/demo/doc.ts | 4 +- .../src/router/modules/demo/draggable-card.ts | 19 --- apps/admin/src/router/modules/demo/echart.ts | 19 --- apps/admin/src/router/modules/demo/flow.ts | 16 -- apps/admin/src/router/modules/demo/form.ts | 19 --- apps/admin/src/router/modules/demo/iframe.ts | 15 -- .../src/router/modules/demo/interaction.ts | 53 +++++++ apps/admin/src/router/modules/demo/layout.ts | 10 -- apps/admin/src/router/modules/demo/modal.ts | 16 -- .../src/router/modules/demo/multi-menu.ts | 73 --------- .../src/router/modules/demo/navigation.ts | 111 ++++++++++++++ .../src/router/modules/demo/precision.ts | 16 -- apps/admin/src/router/modules/demo/qrcode.ts | 16 -- apps/admin/src/router/modules/demo/rely.ts | 16 -- .../src/router/modules/demo/router-demo.ts | 33 ---- .../src/router/modules/demo/scroll-reveal.ts | 16 -- apps/admin/src/router/modules/demo/segment.ts | 19 --- .../src/router/modules/demo/svg-icons.ts | 16 -- apps/admin/src/router/modules/demo/tables.ts | 141 ++++++++++-------- .../src/router/modules/demo/template-hooks.ts | 17 --- .../src/router/modules/demo/utilities.ts | 48 ++++++ .../src/router/modules/demo/web-hooks.ts | 10 -- apps/docs/guide/routing.md | 2 +- 37 files changed, 488 insertions(+), 527 deletions(-) create mode 100644 apps/admin/src/router/modules/demo/assets.ts delete mode 100644 apps/admin/src/router/modules/demo/axios.ts delete mode 100644 apps/admin/src/router/modules/demo/barcode.ts delete mode 100644 apps/admin/src/router/modules/demo/cache-demo.ts create mode 100644 apps/admin/src/router/modules/demo/components.ts delete mode 100644 apps/admin/src/router/modules/demo/context-menu.ts delete mode 100644 apps/admin/src/router/modules/demo/directive.ts delete mode 100644 apps/admin/src/router/modules/demo/draggable-card.ts delete mode 100644 apps/admin/src/router/modules/demo/echart.ts delete mode 100644 apps/admin/src/router/modules/demo/flow.ts delete mode 100644 apps/admin/src/router/modules/demo/form.ts delete mode 100644 apps/admin/src/router/modules/demo/iframe.ts create mode 100644 apps/admin/src/router/modules/demo/interaction.ts delete mode 100644 apps/admin/src/router/modules/demo/layout.ts delete mode 100644 apps/admin/src/router/modules/demo/modal.ts delete mode 100644 apps/admin/src/router/modules/demo/multi-menu.ts create mode 100644 apps/admin/src/router/modules/demo/navigation.ts delete mode 100644 apps/admin/src/router/modules/demo/precision.ts delete mode 100644 apps/admin/src/router/modules/demo/qrcode.ts delete mode 100644 apps/admin/src/router/modules/demo/rely.ts delete mode 100644 apps/admin/src/router/modules/demo/router-demo.ts delete mode 100644 apps/admin/src/router/modules/demo/scroll-reveal.ts delete mode 100644 apps/admin/src/router/modules/demo/segment.ts delete mode 100644 apps/admin/src/router/modules/demo/svg-icons.ts delete mode 100644 apps/admin/src/router/modules/demo/template-hooks.ts create mode 100644 apps/admin/src/router/modules/demo/utilities.ts delete mode 100644 apps/admin/src/router/modules/demo/web-hooks.ts diff --git a/README.md b/README.md index ebafc541..ddbc556a 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Page tabs keep multiple tasks open, and breadcrumbs show where you are. Find men Declare a page in `apps/admin/src/router/modules` to generate its navigation and breadcrumbs. Route metadata controls menu labels and icons, roles, visibility, and `keepAlive`. Detail pages can extend the breadcrumb while keeping the current menu and tab. Role checks cover both menu filtering and direct navigation. Connect your backend to validate sessions and authorize API requests. -[Routing guide](apps/admin/src/router/README.md) · [Nested navigation and caching example](apps/admin/src/router/modules/demo/multi-menu.ts) +[Routing guide](apps/admin/src/router/README.md) · [Nested navigation and caching example](apps/admin/src/router/modules/demo/navigation.ts) ### Reusable components, composables, and SVG icons diff --git a/README.zh-CN.md b/README.zh-CN.md index 67cd6f36..6200e13d 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -38,7 +38,7 @@ Ray Template 是一套**开箱即用的中后台前端模板**,适合搭建管 在 `apps/admin/src/router/modules` 声明页面,模板按路由配置生成菜单和面包屑。路由 `meta` 可以配置菜单文案与图标、角色、显示条件和 `keepAlive`。从列表进入详情时,可以保留当前菜单和标签页,只在面包屑中补充详情层级。角色配置同时用于菜单过滤和直接导航时的守卫。接入业务时,由后端校验会话与接口权限。 -[路由与菜单约定](apps/admin/src/router/README.md) · [多级菜单与缓存示例](apps/admin/src/router/modules/demo/multi-menu.ts) +[路由与菜单约定](apps/admin/src/router/README.md) · [多级菜单与缓存示例](apps/admin/src/router/modules/demo/navigation.ts) ### 组件、Hooks 与图标:从可运行的示例里复用 diff --git a/__test__/router/config.spec.ts b/__test__/router/config.spec.ts index 2aef1bd8..46f841e3 100644 --- a/__test__/router/config.spec.ts +++ b/__test__/router/config.spec.ts @@ -43,11 +43,34 @@ describe('route configuration', () => { const config = exportRouteConfig(bundled) const restored = toRuntimeRoutes(parseRouteConfig(JSON.stringify(config))) - expect(config.routes.length).toBeGreaterThan(10) + expect(expandRoutes(bundled).length).toBeGreaterThan(10) expect(exportRouteConfig(restored)).toEqual(config) expect(expandRoutes(restored)).toEqual(expandRoutes(bundled)) }) + it('preserves demo page URLs when grouping the menus', () => { + const routes = getStaticAppRoutes() + const leaves = expandRoutes(routes).map(({ path }) => path) + + expect(leaves).toEqual( + expect.arrayContaining([ + '/form', + '/svg-icons', + '/barcode', + '/template-hooks', + '/router-demo/router-demo-home', + '/multi/multi-menu-two/sub-menu/sub-menu-one', + '/rely-about', + '/tables/basic', + '/tables/controlled', + '/tables/hooks-output', + ]), + ) + expect( + routes.find(({ path }) => path === '/tables')?.meta.extra?.label, + ).toBe('TablePro') + }) + it('migrates retired icon paths in both menu and external link metadata', () => { const config = parse([ { diff --git a/apps/admin/src/documentation-example.tsx b/apps/admin/src/documentation-example.tsx index 9b5f9ce3..36c6e993 100644 --- a/apps/admin/src/documentation-example.tsx +++ b/apps/admin/src/documentation-example.tsx @@ -13,7 +13,9 @@ import { getStaticAppRoutes, setAppRouteModules, } from '@/router/app-route-modules' +import type { AppRouteRecordRaw } from '@/router/types' import { expandRoutes } from '@/router/utils/expand-routes' +import { joinRoutePath } from '@/router/utils/join-route-path' import { useSettingActions, useSettingGetters } from '@/store' import { useMemoryCache } from '@/utils/cache-backend' import { exampleFocusKey } from '@/views/demo/hooks/example-focus' @@ -45,10 +47,25 @@ const examplePaths = new Set([ '/qrcode', ]) +function selectExampleRoutes( + routes: AppRouteRecordRaw[], + parentPath = '', +): AppRouteRecordRaw[] { + return routes.flatMap((route) => { + const path = joinRoutePath(parentPath, route.path) + + if (examplePaths.has(path)) return [route] + + const children = selectExampleRoutes(route.children ?? [], path) + + return children.length ? [{ ...route, children }] : [] + }) +} + const params = new URLSearchParams(location.search) const withLayout = params.get('layout') === '1' const examples = [ - ...getStaticAppRoutes().filter(({ path }) => examplePaths.has(path)), + ...selectExampleRoutes(getStaticAppRoutes()), { path: '/docs-core-utils', name: 'DocsCoreUtils', diff --git a/apps/admin/src/layout/components/MenuTag/index.tsx b/apps/admin/src/layout/components/MenuTag/index.tsx index 38e0754e..fc6d422d 100644 --- a/apps/admin/src/layout/components/MenuTag/index.tsx +++ b/apps/admin/src/layout/components/MenuTag/index.tsx @@ -316,12 +316,7 @@ export default defineComponent({ onClick={() => this.scrollX('left')} > {{ - icon: () => ( - - ), + icon: () => , }} this.scrollX('right')} > {{ - icon: () => ( - - ), + icon: () => , }}