fast-iot-web/src/router/types.ts

import type { RouteMeta, RouteRecordRaw } from 'vue-router'
import type { Component as VueComponent, defineComponent } from 'vue'
import type { RoleEnum } from '@/enums/roleEnum'

export type Component<T = any> = ReturnType<typeof defineComponent> | (() => Promise<VueComponent>) | (() => Promise<T>)

export interface AppRouteRecordRaw extends Omit<RouteRecordRaw, 'meta' | 'children'> {
  keepAlive?: boolean
  visible?: boolean
  icon?: string
  name: string
  sort?: number
  parentId?: string
  meta: RouteMeta
  component?: Component | string
  components?: Component
  componentName?: string
  children?: AppRouteRecordRaw[]
  props?: Recordable
  fullPath?: string
}

export interface MenuTag {
  // 类型
  type?: 'primary' | 'error' | 'warn' | 'success'
  // 内容
  content?: string
  // 为true则显示小圆点
  dot?: boolean
}

export interface Menu {
  //  菜单名
  name: string
  // 菜单图标,如果没有，则会尝试使用route.meta.icon
  icon?: string
  img?: string
  // 菜单路径
  path: string

  // path contains param, auto assignment.
  paramPath?: string
  // 是否禁用
  disabled?: boolean
  // 子菜单
  children?: Menu[]
  // 菜单排序
  orderNo?: number

  roles?: RoleEnum[]

  meta?: Partial<RouteMeta>
  // 菜单标签设置
  tag?: MenuTag
  // 是否隐藏菜单
  hideMenu?: boolean
}

export interface MenuModule {
  orderNo?: number
  menu: Menu
}

// export type AppRouteModule = RouteModule | AppRouteRecordRaw;
export type AppRouteModule = AppRouteRecordRaw