docs: 📝 优化 route meta 注释
This commit is contained in:
60
src/types/router.d.ts
vendored
Normal file
60
src/types/router.d.ts
vendored
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
import "vue-router";
|
||||||
|
|
||||||
|
declare module "vue-router" {
|
||||||
|
// https://router.vuejs.org/zh/guide/advanced/meta.html#typescript
|
||||||
|
// 可以通过扩展 RouteMeta 接口来输入 meta 字段
|
||||||
|
interface RouteMeta {
|
||||||
|
/**
|
||||||
|
* 菜单名称
|
||||||
|
* @example 'Dashboard'
|
||||||
|
*/
|
||||||
|
title?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 菜单图标
|
||||||
|
* @example 'el-icon-edit'
|
||||||
|
*/
|
||||||
|
icon?: string;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 是否隐藏菜单项
|
||||||
|
* true 隐藏, false 显示
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
hidden?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 始终显示父级菜单,即使只有一个子菜单
|
||||||
|
* true 显示父级菜单, false 隐藏父级菜单,显示唯一子节点
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
alwaysShow?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 是否固定在页签上
|
||||||
|
* true 固定, false 不固定
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
affix?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 是否缓存页面
|
||||||
|
* true 缓存, false 不缓存
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
keepAlive?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 是否在面包屑导航中隐藏
|
||||||
|
* true 隐藏, false 显示
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
breadcrumb?: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 拥有访问该菜单权限的角色编码集合
|
||||||
|
* @example ['admin', 'editor']
|
||||||
|
*/
|
||||||
|
roles?: string[];
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user