config.d.ts
3.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import { MenuTypeEnum, MenuModeEnum, TriggerEnum, MixSidebarTriggerEnum } from '/@/enums/menuEnum';
import { ContentEnum, PermissionModeEnum, ThemeEnum, RouterTransitionEnum } from '/@/enums/appEnum';
import { CacheTypeEnum } from '/@/enums/cacheEnum';
import type { LocaleType } from '/@/locales/types';
export interface MenuSetting {
bgColor: string;
fixed: boolean;
collapsed: boolean;
canDrag: boolean;
show: boolean;
hidden: boolean;
split: boolean;
menuWidth: number;
mode: MenuModeEnum;
type: MenuTypeEnum;
theme: ThemeEnum;
topMenuAlign: 'start' | 'center' | 'end';
trigger: TriggerEnum;
accordion: boolean;
closeMixSidebarOnChange: boolean;
collapsedShowTitle: boolean;
mixSideTrigger: MixSidebarTriggerEnum;
mixSideFixed: boolean;
}
export interface MultiTabsSetting {
// 是否显示
show: boolean;
// 开启快速操作
showQuick: boolean;
canDrag: boolean;
// 显示刷新按钮
showRedo: boolean;
// 显示折叠按钮
showFold: boolean;
}
export interface HeaderSetting {
bgColor: string;
fixed: boolean;
show: boolean;
theme: ThemeEnum;
// 显示全屏按钮
showFullScreen: boolean;
// 开启全屏功能
useLockPage: boolean;
// 显示文档按钮
showDoc: boolean;
// 显示消息中心按钮
showNotice: boolean;
showSearch: boolean;
}
export interface LocaleSetting {
show: boolean;
// Current language
lang: LocaleType;
// default language
fallback: LocaleType;
// available Locales
availableLocales: LocaleType[];
}
export interface TransitionSetting {
// Whether to open the page switching animation
enable: boolean;
// Route basic switching animation
basicTransition: RouterTransitionEnum;
// Whether to open page switching loading
openPageLoading: boolean;
// Whether to open the top progress bar
openNProgress: boolean;
}
export interface ProjectConfig {
locale: LocaleSetting;
permissionCacheType: CacheTypeEnum;
// 是否显示配置按钮
showSettingButton: boolean;
// 权限模式
permissionMode: PermissionModeEnum;
// 网站灰色模式，用于可能悼念的日期开启
grayMode: boolean;
// 是否开启色弱模式
colorWeak: boolean;
// 主题色
themeColor: string;
// 全屏显示主界面,不显示菜单,及顶部
fullContent: boolean;
// 区域宽度
contentMode: ContentEnum;
// 是否显示logo
showLogo: boolean;
showFooter: boolean;
headerSetting: HeaderSetting;
// 菜单类型
// menuType: MenuTypeEnum;
menuSetting: MenuSetting;
// 多标签页设置
multiTabsSetting: MultiTabsSetting;
transitionSetting: TransitionSetting;
// pageLayout是否开启keep-alive
openKeepAlive: boolean;
//
// 锁屏时间
lockTime: number;
// 显示面包屑
showBreadCrumb: boolean;
// 显示面包屑图标
showBreadCrumbIcon: boolean;
// 使用error-handler-plugin
useErrorHandle: boolean;
// 是否开启回到顶部
useOpenBackTop: boolean;
// 是否可以嵌入iframe页面
canEmbedIFramePage: boolean;
// 切换界面的时候是否删除未关闭的message及notify
closeMessageOnSwitch: boolean;
// 切换界面的时候是否取消已经发送但是未响应的http请求。
removeAllHttpPending: boolean;
}
export interface GlobConfig {
// 网站标题
title: string;
// 项目路径
apiUrl: string;
uploadUrl?: string;
urlPrefix?: string;
shortName: string;
}
export interface GlobEnvConfig {
// 网站标题
VITE_GLOB_APP_TITLE: string;
// 项目路径
VITE_GLOB_API_URL: string;
VITE_GLOB_API_URL_PREFIX?: string;
VITE_GLOB_APP_SHORT_NAME: string;
VITE_GLOB_UPLOAD_URL?: string;
}
interface GlobWrap {
globSetting: Readonly<GlobConfig>;
}
interface ProjectSettingWrap {
projectSetting: Readonly<ProjectConfig>;
}