Skip to content

自定义平台配置

TIP

支持根据项目的需求自定义平台配置

自定义配置文件位于 src/system.config.ts

自定义配置的静态资源位于 public/system-config 目录下

支持的配置项

javascript
interface ISystemConfig {
  homePage: string // 首页路由

  // 不需要的配置项设置为 '' 即可
  // 配置的静态文件全部放在public/system-config文件夹下
  loginBg: string // 登录页背景图
  loginBgDark: string // 登录页背景图(暗色)
  loginTitle: string // 登录页欢迎语 标题
  navBg: string // 顶部导航栏背景图
  navBgDark: string // 顶部导航栏背景图(暗色)
  navTitle: string[] // 顶部导航栏内容
  navTitleMargin: number // 顶部导航栏内容间隔

  sysTitle: string // 平台名称 - 菜单顶部显示的名称
  sysIcon: string // 平台图标
  sysAlign: 'left' | 'center' | 'right' // 平台名称 - 菜单顶部显示的位置
  // 平台顶部右侧操作图标是否显示
  // 未配置的默认显示
  tools: {
    tenant: boolean // 租户
    search: boolean // 搜索
    notice: boolean // 通知
    i18n: boolean // 国际化
    fullScreen: boolean // 全屏
    refresh: boolean // 刷新
    theme: boolean // 主题
    setting: boolean // 设置
    userInfo: boolean // 用户信息
  }

  // 登录页配置项
  loginTools: {
    forgetPassword: boolean // 忘记密码
    register: boolean // 注册
    remberMe: boolean // 记住我
    // 数组形式传递,可设置多个登录方式;传[]则不显示登录方式
    loginType: Array<'password' | 'phone' | 'wx' | 'dd'> // 登录方式 password: 密码登录 phone: 手机号登录 wx: 微信登录 dd: 钉钉登录
  }

  // 用户管理新增 必填项配置
  // 未配置的默认 非必填
  user: {
    // 姓名
    name?: boolean
    // 用户名
    username?: boolean
    // 昵称
    nickname?: boolean
    // 手机号
    phone?: boolean
    // 邮箱
    email?: boolean
    // 部门
    dept?: boolean
    // 角色
    role?: boolean
    // 岗位
    post?: boolean
  }
}

默认配置

修改默认配置文件内的参数即可自定义平台配置

javascript
export const systemConfig: ISystemConfig = {
  homePage: "/", // 比如要将用户管理设置为首页,这里就填写 '/system-manage/user-manage'

  loginBg: "login_bg.webp",
  loginBgDark: "login_bg_dark.webp",
  loginTitle: "您好,欢迎登录",
  navBg: "nav_bg.webp",
  navBgDark: "nav_bg_dark.webp",
  // 数组形式传递,可设置多个标题
  navTitle: ["一诺千金", "合作共赢"],
  navTitleMargin: 70,

  sysTitle: "金合技术中台",
  sysIcon: "logo.png",
  sysAlign: "center",

  tools: {
    tenant: true,
    search: true,
    notice: true,
    i18n: true,
    fullScreen: true,
    refresh: true,
    theme: true,
    setting: true,
    userInfo: true,
  },

  // 只配置需要必填的项即可
  user: {
    name: true,
    username: true,
    phone: true,
  },
  loginTools: {
    forgetPassword: true,
    register: true,
    remberMe: true,
    // 数组形式传递,可设置多个登录方式;传[]则不显示登录方式
    loginType: ["password", "phone", "wx", "dd"],
  },
};