Skip to content

Latest commit

 

History

History
241 lines (185 loc) · 8.19 KB

README.md

File metadata and controls

241 lines (185 loc) · 8.19 KB
Raw

Antd Multi Tabs Admin

🛠️Antd多标签页后台管理模板🛠️
由于业务上有多页签需求，网上找了一圈，都是基于antd pro的模板，太重了，不喜欢😒。
于是自己从以前的框架上改造，搭了这么一个精简版框架，用得也舒服，原创🤪。

预览地址


特性

  • 📐: 代码规模：原创精简版脚手架，主张最少，不臃肿
  • 🚅: 追求前沿：全站使用 React Hooks 开发，抛弃 Class
  • 💎: 优雅美观：基于 Ant Design 体系精心设计
  • 🚀: 流行技术：使用 React/Redux/Antd 等前端前沿技术开发
  • 🎨: 主题样式：使用流行的暗黑模式主题，支持深/浅色主题切换

特点

  • 多 tab 页签➕右键菜单，提升效率
  • Redux / Toolkit 状态管理➕持久化
  • 封装实用 axios 请求
  • 动态链式面包屑导航
  • 菜单页面路由权限控制
  • less➕css module 样式隔离, 简单样式则可以使用tailwindcss class来替代
  • 列表➕分页➕多选➕搜索联动组件
  • 可自定义 webpack 配置➕优化打包
  • api请求模拟(MSW)
  • 单点登录(OpenId Connect)集成

近期规划

  • 尝试多种主题色切换或取色器动态换肤功能（调研开发中👀）
  • 集成单元测试 jest + enzyme，争取覆盖率100%💪🏻💪🏻（学习中🤫）

动态主题

目前 [email protected] 已支持动态主题（实验性），感兴趣的话可以去玩玩，互相探讨。

预览图


使用

使用命令行

$ npm install -g typescript
$ git clone https://github.com/hsl947/react-antd-multi-tabs-admin.git
$ yarn install
$ yarn start         # 访问 http://localhost:666

权限控制

如果不需要权限控制，可自行注释去掉权限功能。

# src/components/common/menu/index.tsx

// 创建可展开的第一级子菜单
const creatSubMenu = (data: any): JSX.Element => {
  // const menuItemList = []
  // data.routes.map((item: any) => {
  //   const arr = permission.filter((ele: any) => item.key === ele.code)
  //   if (arr.length > 0) {
  //     menuItemList.push(renderMenu(item))
  //   }
  //  return arr
  // })

  const menuItemList = data.routes.reduce(
    (prev: any, next: any) => [...prev, renderMenu(next)],
    []
  )

  return menuItemList.length > 0 ? (
    <SubMenu key={data.key} title={subMenuTitle(data)}>
      {menuItemList}
    </SubMenu>
  ) : null
}

# src/pages/container/index.tsx

// 检查权限
const checkAuth = (newPathname: string): boolean => {
  // 不需要检查权限的
  // if (noCheckAuth.includes(newPathname)) {
  //   return true
  // }
  // const { tabKey: currentKey } = getKeyName(newPathname)
  // return isAuthorized(currentKey)

  // 一定返回 true
  return !!newPathname
}


# src/components/common/tabPanes/index.tsx

// 移除tab
const remove = (targetKey: string): void => {
  const delIndex = panes.findIndex(
    (item: CommonObjectType) => item.key === targetKey
  )
  panes.splice(delIndex, 1)

  // 删除非当前tab
  if (targetKey !== activeKey) {
    const nextKey = activeKey
    setPanes(panes)
    setActiveKey(nextKey)
    storeTabs(panes)
    return
  }

  // 删除当前tab，地址往前推
  const nextPath = curTab[delIndex - 1]
  const { tabKey } = getKeyName(nextPath)
  // 如果当前tab关闭后，上一个tab无权限，就一起关掉
  // if (!isAuthorized(tabKey) && nextPath !== '/') {
  //   remove(tabKey)
  //   history.push(curTab[delIndex - 2])
  // } else {
  //   history.push(nextPath)
  // }
  history.push(nextPath)
  setPanes(panes)
  storeTabs(panes)
}

Redux/Toolkit 的使用说明

你仍然可以使用 redux @Reduxjs/Toolkit是 Redux的封装.使用如下 Reduxjs/Toolkit 用于减少redux模板代码, 按照就近原则, 分割代码. 一个状态管理容器切片示例如下.

# 在/src/store/slicers
import { createSlice } from '@reduxjs/toolkit'
import type { RootState } from '@/store' // typescript intelligence

export interface AppState {
  theme: string
  collapsed: boolean // 菜单收纳状态, 用于垂直布局
  menuMode: 'horizontal' | 'vertical' // 菜单模式, 用于水平布局
}

const initialState: AppState = {
  collapsed: false,
  theme: 'dark',
  menuMode: 'horizontal'
}

export const appSlice = createSlice({
  name: 'app',
  initialState,
  // The `reducers` field lets us define reducers and generate associated actions
  reducers: {
    setTheme(state, action) {
      state.theme = action.payload
    },
    // ... other setters
  }
})

// actions
export const { setCollapsed, setTheme, setMenuMode } = appSlice.actions

// getters
export const selectTheme = (state: RootState) => state.app.theme
export const selectCollapsed = (state: RootState) => state.app.collapsed
export const selectMenuMode = (state: RootState) => state.app.menuMode
// 返回 已切片的 reducer
export default appSlice.reducer

路由/菜单配置

# 所有路由写在 /src/route/routes.ts （包括菜单栏的路由）
  用于路由权限控制

# 菜单路由基于路由生成, 路由项上增加额外字段标识: 是否在菜单栏展示,及图标等信息

# 你也可以分开写, 增强带单定制功能.

关于换肤配置

本框架是使用 less.js 实现动态切换主题，js文件在 /public/less.min.js

# 主题配置文件在 /public/color.less

引用了 antd 组件后，基本不需要自己额外自定义主题样式，因为主题文件里都有。
但是！！！
如果自己写了自定义组件，切换主题后样式显示不正常，
则需要自己在 color.less 底部添加深浅主题对应的样式，具体参考主题文件内额外配置。

支持环境

现代浏览器及 IE11。

IE / Edge
IE / Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 Opera
Opera
IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

参与贡献

我们非常欢迎你的贡献，你可以通过以下方式和我们一起共建 😃：

友情赞助 - Sponsor

开源不易，请我们喝一杯咖啡，我们会更有动力 😃

Open source is not easy, invite us to drink a cup of coffee, we will be more motivated.