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