Skip to content

Latest commit

 

History

History

Folders and files

README.md

Dashboard

A configurable dashboard built with react.
Dashboard可方便开发者快速开发控制台类web app,但暂时没有填充有意义的内容

overview

try it here

  • features
    • themeable, dark mode out of the box
    • configurable layout
    • configurable routes

开始使用

npm run start
  • 使用说明

    • 根据登录界面的提示,可选择测试账户登录仪表板
    • 左侧边栏会显示./config/routes.ts中配置过的路由
    • 右侧悬浮按钮可打开右侧配置面板,支持快速配置主题、布局
  • 实现说明

    • 无需后端服务器即可运行,直接在前端mock了fetch请求执行登录

配置约定

  • 在项目运行前支持的配置项,只作为默认初始值,后续修改不会生效

    • ./config/defaultSettings.ts 暂时支持的配置项很少,只包括标题、主题色
  • dev-server开发模式下支持的配置

    • ./config/routes.ts 配置路由及其对应的文件路径

路由配置

  • ./config/routes.ts配置的路由会在左侧边栏的菜单项中出现

    • 若要不显示在左侧边栏中,可不配置name
  • 每个path支持配置的component包括

    • react组件
    • pages目录下.tsx文件的相对路径
  • path支持配置外部链接,以 http(s) 开头,此时 component 配置项会被忽略

布局配置

  • 左侧边栏

    • 普通侧边栏
    • mini侧边栏
    • 不显示侧边栏
    • 可切换固定、滚动
  • 右侧配置面板

    • 显示/隐藏浮动按钮
    • 不显示右侧配置面板
    • 可切换固定、滚动

screenshots

  • 默认布局:左侧边栏显示,右侧面板浮动

  • 设置布局:左侧边栏隐藏,右侧面板dock

  • 设置布局:非全宽界面,dark模式

其他配置

  • 可在前端配置用户的权限或路由的权限,让不同权限的用户看到的菜单不同,方便与rbac鉴权集成
    • 暂时只支持路由级的权限控制,不支持页面内元素的权限控制

notes