应用配置

请在应用内（apps文件下） /src/settings.ts 文件中进行配置，而 /src/settings.default.ts 为框架的默认配置，请勿在该文件内修改。

关于配置的类型定义，可以在 apps/*/types/globals.d.ts 文件中查阅。

注意

文档中提供的配置介绍，如果在本地的开发环境使用中报错或者无法生效，说明你使用的版本不支持或者配置参数有变动，你可以打开 /src/settings.default.ts 查看当前版本的完整配置作为参考。

并且如果你使用的是 Visual Studio Code ，鼠标悬浮到属性上时，会有属性的介绍：

app 配置配置

lightTheme

• 类型 string
• 默认值 classic

浅色主题配置，在颜色方案配置为 light时，使用对应的主题配置

浅色主题默认配置了六种主题，目录位置在 apps/*/themes/system/light 下，你可以根据自己的需求进行修改

TIP

详细的主题配置请查看主题

darkTheme

• 类型 string
• 默认值 dark

暗色主题配置，在颜色方案配置为 dark时，使用对应的主题配置

暗色主题默认配置了六种主题，目录位置在 apps/*/themes/system/dark 下，你可以根据自己的需求进行修改

TIP

详细的主题配置请查看主题

colorScheme

• 类型 '' | 'light' | 'dark'
• 默认值 light

颜色方案，使用 '' 跟随系统，'light' 明亮模式，'dark' 暗黑模式

TIP

详细的主题配置请查看主题

defaultLang

• 类型 'zh-cn' | 'en' | 'zh-tw' | string
• 默认值 ''

默认语言，'' 跟随浏览器语言设置, zh-cn 中文，en 英文，zh-tw 繁体

TIP

详细配置请查看国际化

enablePermission

• 类型 boolean
• 默认值 true

是否启用权限控制，开启后会根据权限配置进行路由过滤，目前框架使用的是基于角色的权限控制，由后端返回 code 编码，前端根据 code 编码进行菜单过滤，只有拥有权限的菜单才会显示，其他菜单不会被 router 注册，如果强制按照路径跳转会返回 403 页面，如果是本就没有建设的页面会返回 404 页面。

enableProgress

• 类型 boolean
• 默认值 true

是否启用顶部进度条，开启后会在页面顶部显示一个进度条，用于展示页面加载进度。

enableDynamicTitle

• 类型 boolean
• 默认值 true

是否启用动态标题，开启后会根据路由的 meta.title 属性动态设置页面 tabbar 标题、面包屑 breadcrumb的值, document.title 的值。例如 首页 - 技术中台管理系统。

storagePrefix

• 类型 string
• 默认值 wsy_rbac

存储前缀，用于存储在 localStorage 、cookies 或者 sessionStorage 中的数据前缀，用于区分不同的应用。

提示

storagePrefix 的值很重要，如果你的应用部署在同一个域名下，但是不同的应用如果不设置 storagePrefix ，可能会导致浏览器存储数据冲突，例如 token等数据。 在开发环境因为 vite 启动的端口默认是 5173, 如果每一个应用都是默认的 storagePrefix，那么也会导致存储数据冲突。

enableWatermark beta

• 类型 boolean
• 默认值 false

是否启用水印，开启后会在页面上显示一个水印

routeBaseOn beta

• 类型 'frontend' | 'backend' | 'filesystem'
• 默认值 frontend

路由数据来源,'frontend' 前端,'backend' 后端,'filesystem' 文件系统

enableUserPreferences beta

• 类型 boolean
• 默认值 true

是否启用用户偏好设置

TIP

详细配置请查看用户偏好设置

enableAppSetting

• 类型 boolean
• 默认值 true

是否启用应用设置，开启后会在侧边栏显示一个应用设置按钮，点击后可以设置应用的一些配置

提示

强烈建议生产环境关闭 enableAppSetting 配置，避免用户随意修改配置导致应用异常

home 控制台配置 beta

注意

不建议开启主页，除非你真的业务上有一个不需要权限控制的主页，用来展示数据。

enable

• 类型 boolean
• 默认值 false

是否开启控制台

title

• 类型 string
• 默认值 '控制台'

控制台显示名称

layout 布局配置

widthMode

• 类型 'adaption' | 'adaption-min-width' | 'center' | 'center-max-width'
• 默认值 'adaption'

页宽模式，当设置为非'adaption'时，可以去./src/assets/styles/layout.scss里设置--g-app-width宽度变量。选项包括：

• 'adaption'：自适应
• 'adaption-min-width'：自适应（有最小宽度）
• 'center'：定宽居中
• 'center-max-width'：定宽居中（有最大宽度）

enableMobileAdaptation

• 类型 boolean
• 默认值 true

是否开启移动端适配。开启后，当页面宽度小于992px时自动切换为移动端展示。

menu 菜单配置

baseOn

• 类型 'frontend' | 'backend' | false
• 默认值 'frontend'

导航栏数据来源，当 app.routeBaseOn: 'filesystem' 时生效。可选值为'frontend'前端，'backend'后端，或false。

menuMode

• 类型 'side' | 'head' | 'single' | 'only-side' | 'only-head'
• 默认值 'head'

导航栏模式。可选值为：

• 'side'：侧边栏模式（有主导航）
• 'head'：顶部模式
• 'single'：侧边栏模式（无主导航）
• 'only-side'：侧边栏精简模式
• 'only-head'：顶部精简模式

isRounded

• 类型 boolean
• 默认值 true

导航栏是否圆角。

menuActiveStyle

• 类型 '' | 'arrow' | 'line' | 'dot'
• 默认值 ''

导航栏激活风格。可选值为：

• ''：无特殊风格
• 'arrow'：箭头
• 'line'：线条
• 'dot'：圆点

switchMainMenuAndPageJump

• 类型 boolean
• 默认值 true

切换主导航是否跳转页面。

subMenuUniqueOpened

• 类型 boolean
• 默认值 true

次导航是否只保持一个子项的展开。

subMenuOnlyOneHide

• 类型 boolean
• 默认值 true

次导航只有一个导航时是否自动隐藏。

subMenuCollapse

• 类型 boolean
• 默认值 false

次导航是否收起。

enableSubMenuCollapseButton

• 类型 boolean
• 默认值 true

是否开启次导航的展开/收起按钮。

enableHotkeys

• 类型 boolean
• 默认值 false

是否开启主导航切换快捷键。

topbar 顶部栏配置

mode

• 类型 'static' | 'fixed' | 'sticky'
• 默认值 'fixed'

顶部栏的模式。可选值为：

• 'static'：静止，跟随页面滚动
• 'fixed'：固定，不跟随页面滚动，始终固定在顶部
• 'sticky'：粘性，页面往下滚动时隐藏，往上滚动时显示

switchTabbarAndToolbar

• 类型 boolean
• 默认值 false

是否切换显示标签栏和工具栏的显示位置。可选值为：

• false：标签栏在工具栏上面
• true：工具栏在标签栏上面

tabbar 标签栏配置 beta

enable

• 类型 boolean
• 默认值 true

是否开启标签栏。

style

• 类型 'fashion' | 'card' | 'square'
• 默认值 'fashion'

标签栏风格。可选值为：

• 'fashion'：时尚
• 'card'：卡片
• 'square'：方块

enableIcon

• 类型 boolean
• 默认值 true

是否开启标签栏图标显示。

mergeTabsBy

• 类型 '' | 'routeName' | 'activeMenu'
• 默认值 'activeMenu'

标签页合并规则。可选值为：

• ''：不合并
• 'routeName'：根据路由名称，相同路由名称的路由合并
• 'activeMenu'：根据路由的 meta.activeMenu 字段，与指向的目标路由合并

enableMemory

• 类型 boolean
• 默认值 true

是否开启标签栏记忆功能。

enableHotkeys

• 类型 boolean
• 默认值 true

是否开启标签栏快捷键。

storageTo

• 类型 'local' | 'server'
• 默认值 'local'

固定标签页存储位置。可选值为：

• 'local'：本地存储
• 'server'：服务器存储

toolbar 工具栏配置

enableNotification

• 类型 boolean
• 默认值 true

是否开启通知中心。

enableI18n

• 类型 boolean
• 默认值 true

是否开启国际化。

enableFullscreen

• 类型 boolean
• 默认值 true

是否开启全屏功能。

enablePageReload

• 类型 boolean
• 默认值 true

是否开启页面刷新功能。

enableColorScheme

• 类型 boolean
• 默认值 true

是否开启颜色主题切换功能。

favorites 收藏夹配置

enable

• 类型 boolean
• 默认值 true

是否开启收藏夹。

storageTo

• 类型 'local' | 'server'
• 默认值 'local'

存储位置。可选值为：

• 'local'：本地存储
• 'server'：服务器存储

breadcrumb

enable 面包屑配置

• 类型 boolean
• 默认值 true

是否开启面包屑导航。

style

• 类型 string
• 默认值 ''

面包屑导航风格。可选值为：

• ''：默认
• 'modern'：现代

enableMainMenu

• 类型 boolean
• 默认值 true

是否在面包屑导航里显示主导航。

mainPage 容器配置 beta

enableHotkeys

• 类型 boolean
• 默认值 true

是否开启页面快捷键。

iframeCacheMax

• 类型 number
• 默认值 3

iframe页面最大缓存数量。

enableTransition

• 类型 boolean
• 默认值 true

是否开启页面切换动画。

transitionMode

• 类型 'fade' | 'slide-left' | 'slide-right' | 'slide-top' | 'slide-bottom'
• 默认值 'fade'

页面切换动画。可选值为：

• 'fade'：淡入淡出
• 'slide-left'：向左滑动
• 'slide-right'：向右滑动
• 'slide-top'：向上滑动
• 'slide-bottom'：向下滑动

navSearch 导航搜索配置

enable

• 类型 boolean
• 默认值 true

是否开启导航搜索。

enableHotkeys

• 类型 boolean
• 默认值 true

是否开启导航搜索快捷键。

copyright 底部版权配置

enable

• 类型 boolean
• 默认值 false

是否开启底部版权，同时在路由meta对象里可以单独设置某个路由是否显示底部版权信息。

dates

• 类型 string
• 默认值 '2024'

网站运行日期。

company

• 类型 string
• 默认值 'PUBINFO'

公司名称。

website

• 类型 string
• 默认值 ''

网站地址。

beian

• 类型 string
• 默认值 ''

网站备案号。