router.d.ts 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. import type { RouteRecordRaw } from 'vue-router'
  2. import { defineComponent } from 'vue'
  3. /**
  4. * redirect: noredirect 当设置 noredirect 的时候该路由在面包屑导航中不可被点击
  5. * name:'router-name' 设定路由的名字,一定要填写不然使用<keep-alive>时会出现各种问题
  6. * meta : {
  7. hidden: true 当设置 true 的时候该路由不会再侧边栏出现 如404,login等页面(默认 false)
  8. alwaysShow: true 当你一个路由下面的 children 声明的路由大于1个时,自动会变成嵌套的模式,
  9. 只有一个时,会将那个子路由当做根路由显示在侧边栏,
  10. 若你想不管路由下面的 children 声明的个数都显示你的根路由,
  11. 你可以设置 alwaysShow: true,这样它就会忽略之前定义的规则,
  12. 一直显示根路由(默认 false)
  13. title: 'title' 设置该路由在侧边栏和面包屑中展示的名字
  14. icon: 'svg-name' 设置该路由的图标
  15. noCache: true 如果设置为true,则不会被 <keep-alive> 缓存(默认 false)
  16. breadcrumb: false 如果设置为false,则不会在breadcrumb面包屑中显示(默认 true)
  17. affix: true 如果设置为true,则会一直固定在tag项中(默认 false)
  18. noTagsView: true 如果设置为true,则不会出现在tag中(默认 false)
  19. activeMenu: '/dashboard' 显示高亮的路由路径
  20. canTo: true 设置为true即使hidden为true,也依然可以进行路由跳转(默认 false)
  21. permission: ['edit','add', 'delete'] 设置该路由的权限
  22. }
  23. **/
  24. declare module 'vue-router' {
  25. interface RouteMeta extends Record<string | number | symbol, unknown> {
  26. hidden?: boolean
  27. alwaysShow?: boolean
  28. title?: string
  29. icon?: string
  30. noCache?: boolean
  31. breadcrumb?: boolean
  32. affix?: boolean
  33. activeMenu?: string
  34. noTagsView?: boolean
  35. followAuth?: string
  36. canTo?: boolean
  37. permission?: string[]
  38. }
  39. }
  40. type Component<T = any> =
  41. | ReturnType<typeof defineComponent>
  42. | (() => Promise<typeof import('*.vue')>)
  43. | (() => Promise<T>)
  44. declare global {
  45. declare interface AppRouteRecordRaw extends Omit<RouteRecordRaw, 'meta'> {
  46. name: string
  47. meta: RouteMeta
  48. component?: Component | string
  49. children?: AppRouteRecordRaw[]
  50. props?: Recordable
  51. fullPath?: string
  52. }
  53. declare interface AppCustomRouteRecordRaw extends Omit<RouteRecordRaw, 'meta'> {
  54. name: string
  55. meta: RouteMeta
  56. component: string
  57. path: string
  58. redirect: string
  59. children?: AppCustomRouteRecordRaw[]
  60. }
  61. }