ruoyi-plus-soybean/src/router/constant/index.ts

import type { RouteKey } from '@/interface';

interface RouteConst {
  /** 路由名称 */
  name: RouteKey;
  /** 路由路径 */
  path: string;
  /** 路由标题 */
  title: string;
}

/** 声明的路由名称、路径和标题 */
const routeConstMap = new Map<RouteKey, RouteConst>([
  [
    'root',
    {
      name: 'root',
      path: '/',
      title: 'Root'
    }
  ],
  [
    'login',
    {
      name: 'login',
      path: '/login',
      title: '登录'
    }
  ],
  [
    'no-permission',
    {
      name: 'no-permission',
      path: '/403',
      title: '无权限'
    }
  ],
  [
    'not-found',
    {
      name: 'not-found',
      path: '/404',
      title: '未找到'
    }
  ],
  [
    'service-error',
    {
      name: 'service-error',
      path: '/500',
      title: '服务器错误'
    }
  ],
  [
    'dashboard',
    {
      name: 'dashboard',
      path: '/dashboard',
      title: '仪表盘'
    }
  ],
  [
    'dashboard_analysis',
    {
      name: 'dashboard_analysis',
      path: '/dashboard/analysis',
      title: '分析页'
    }
  ],
  [
    'dashboard_workbench',
    {
      name: 'dashboard_workbench',
      path: '/dashboard/workbench',
      title: '工作台'
    }
  ],
  [
    'document',
    {
      name: 'document',
      path: '/document',
      title: '文档'
    }
  ],
  [
    'document_vue',
    {
      name: 'document_vue',
      path: '/document/vue',
      title: 'vue文档'
    }
  ],
  [
    'document_vite',
    {
      name: 'document_vite',
      path: '/document/vite',
      title: 'vite文档'
    }
  ],
  [
    'document_naive',
    {
      name: 'document_naive',
      path: '/document/naive',
      title: 'naive文档'
    }
  ],
  [
    'document_project',
    {
      name: 'document_project',
      path: 'https://docs.soybean.pro/',
      title: '项目文档（外链）'
    }
  ],
  [
    'plugin',
    {
      name: 'plugin',
      path: '/plugins',
      title: '插件示例'
    }
  ],
  [
    'plugin_map',
    {
      name: 'plugin_map',
      path: '/plugin/map',
      title: '地图'
    }
  ],
  [
    'plugin_video',
    {
      name: 'plugin_video',
      path: '/plugin/video',
      title: '视频'
    }
  ],
  [
    'plugin_editor',
    {
      name: 'plugin_editor',
      path: '/plugin/editor',
      title: '编辑器'
    }
  ],
  [
    'plugin_editor_quill',
    {
      name: 'plugin_editor_quill',
      path: '/plugin/editor/quill',
      title: '富文本编辑器'
    }
  ],
  [
    'plugin_editor_markdown',
    {
      name: 'plugin_editor_markdown',
      path: '/plugin/editor/markdown',
      title: 'markdown编辑器'
    }
  ],
  [
    'plugin_swiper',
    {
      name: 'plugin_swiper',
      path: '/plugin/swiper',
      title: 'Swiper插件'
    }
  ],
  [
    'plugin_copy',
    {
      name: 'plugin_copy',
      path: '/plugin/copy',
      title: '剪贴板'
    }
  ],
  [
    'plugin_icon',
    {
      name: 'plugin_icon',
      path: '/plugin/icon',
      title: '图标'
    }
  ],
  [
    'plugin_print',
    {
      name: 'plugin_print',
      path: '/plugin/print',
      title: '打印'
    }
  ],
  [
    'component',
    {
      name: 'component',
      path: '/component',
      title: '组件示例'
    }
  ],
  [
    'component_button',
    {
      name: 'component_button',
      path: '/component/button',
      title: '按钮'
    }
  ],
  [
    'component_card',
    {
      name: 'component_card',
      path: '/component/card',
      title: '卡片'
    }
  ],
  [
    'component_table',
    {
      name: 'component_table',
      path: '/component/table',
      title: '表格'
    }
  ],
  [
    'multi-menu',
    {
      name: 'multi-menu',
      path: '/multi-menu',
      title: '多级菜单'
    }
  ],
  [
    'multi-menu_first',
    {
      name: 'multi-menu_first',
      path: '/multi-menu/first',
      title: '一级菜单'
    }
  ],
  [
    'multi-menu_first_second',
    {
      name: 'multi-menu_first_second',
      path: '/multi-menu/first/second',
      title: '二级菜单'
    }
  ],
  [
    'exception',
    {
      name: 'exception',
      path: '/exception',
      title: '异常页'
    }
  ],
  [
    'exception_403',
    {
      name: 'exception_403',
      path: '/exception/403',
      title: '异常页-403'
    }
  ],
  [
    'exception_404',
    {
      name: 'exception_404',
      path: '/exception/404',
      title: '异常页-404'
    }
  ],
  [
    'exception_500',
    {
      name: 'exception_500',
      path: '/exception/500',
      title: '异常页-500'
    }
  ],
  [
    'about',
    {
      name: 'about',
      path: '/about',
      title: '关于'
    }
  ],
  [
    'website',
    {
      name: 'website',
      path: '/website',
      title: '网址导航'
    }
  ]
]);

/** 获取路由的声明(name、path、title) */
export function getRouteConst(key: RouteKey) {
  return routeConstMap.get(key)!;
}
/** 路由名称 */
export function routeName(key: RouteKey) {
  return routeConstMap.get(key)!.name;
}
/** 路由路径 */
export function routePath(key: RouteKey) {
  return routeConstMap.get(key)!.path;
}
/** 路由标题 */
export function routeTitle(key: RouteKey) {
  return routeConstMap.get(key)!.title;
}