Skip to content

全局变量

在软件开发中,全局变量和枚举可以方便的管理应用生命周期内的上下文。开发者可以在开发功能时评估是否需要使用全局变量进行变量的管理和使用。

constants 目录是存放全局变量的标准目录。

🕸️目录结构

ts
📁 constants
┣━━📁src
  └── 📄appEnum.ts          // 应用级枚举
  └── 📄breakpoint.ts       // 断点
  └── 📄cacheEnum.ts        // 缓存枚举
  └── 📄designSetting.ts    // 主题枚举
  └── 📄menuEnum.ts         // 菜单枚举
  └── 📄multipleTabEnum.ts  // tabs菜单枚举
  └── 📄router.ts           // 路由
  └── 📄sidebar.ts          // 侧边栏
  └── 📄index.ts

📃常量列表

Vben3定义了如下常量:

应用常量

常量名说明
ContentLayoutEnumFULLFIXED调整内容宽度
ThemeEnumDARKLIGHT主题颜色
NavBarModeEnumSIDEBARMIX_SIDEBARMIXTOP_MENU导航栏布局样式
SettingButtonPositionEnumAUTOHEADERFIXED设置按钮位置
SessionTimeoutProcessingEnumROUTE_JUMPPAGE_COVERAGESESSION超时处理方式
PermissionModeEnumROLEBACKROUTE_MAPPING权限校验模式
RouterTransitionEnumZOOM_FADEZOOM_OUTFADE_SIDEFADEFADE_BOTTOMFADE_SCALE页面切换动画类型
RoleEnumSUPERTEST角色类型
ComponentSizeEnumDEFAULTSMALLLARGE组件大小类型
ErrorTypeEnumVUESCRIPTRESOURCEAJAXPROMISE错误类型

断点

常量名说明
ScreenSizeEnumXSSMMDLGXLXXL屏幕断点枚举
ScreenValueEnum48057676899212001600屏幕断点枚举值

缓存

常量名说明
TOKEN_KEYTOKEN__token key
LOCALE_KEYLOCALE__locale key
USER_INFO_KEYUSER__INFO__user info key
ROLES_KEYROLES__KEY__roles key
PROJ_CFG_KEYPROJ__CFG__KEY__project config cache key
LOCK_INFO_KEYLOCK__INFO__KEY__lock screen info cache key
MULTIPLE_TABS_KEYMULTIPLE_TABS__KEY__multiple tabs key
APP_DARK_MODE_KEY___APP__DARK__MODE__app dark mode status cache key
APP_LOCAL_CACHE_KEYCOMMON__LOCAL__KEY__app local cache key
APP_SESSION__KEY__COMMON__SESSION__KEY__app session cache key

颜色主题

常量名说明
APP_PRESET_COLOR_LIST预编译主题色
HandlerSettingEnum配置枚举
ThemeChangeEnum主题配置

菜单枚举

常量名说明
TriggerEnumNONEFOOTERCENTERHEADER折叠触发器的位置
Modeverticalvertical-righthorizontalinline模式
MenuModeEnumVERTICALHORIZONTALVERTICAL_RIGHTINLINE菜单类型
MenuSplitTypeEnumNONETOPLEFT菜单分割类型
TopMenuAlignEnumCENTERSTARTEND顶部菜单对齐类型
MixSidebarTriggerEnumHOVERCLICK混合侧边栏的触发类型

多标签

常量名说明
TabContentEnumTAB_TYPEEXTRA_TYPE多标签内容类型
TabActionEnumREFRESH_PAGECLOSE_CURRENTCLOSE_LEFTCLOSE_RIGHTCLOSE_OTHERCLOSE_ALLSCALECLOSE多标签操作类型

路由

常量名说明
REDIRECT_NAMERedirect定义路由重定向名称
PAGE_NOT_FOUND_NAMEPageNotFound定义路由无法找到的名称
BASIC_LOGIN_PATH/login定义基础路由入口
BASIC_HOME_PATH/dashboard定义首页地址
BASIC_ERROR_PATH/exception错误页面地址
BASIC_LOCK_PATH/lock定义锁屏页面地址
PageEnumBASE_LOGINBASE_HOMEERROR_PAGEERROR_LOG_PAGEBASE_LOCK页面枚举

侧边栏

常量名说明
SIDE_BAR_MINI_WIDTH48侧边栏最小宽度
SIDE_BAR_SHOw_TIT_MINI_WIDTH80侧边栏标题最小宽度