mirror of https://github.com/halo-dev/halo-admin
54755c5842
#### What type of PR is this? /kind api-change /kind improvement /milestone 2.0 #### What this PR does / why we need it: Ref https://github.com/halo-dev/halo/issues/2595 重构路由和侧边菜单生成的逻辑，**注意，此 PR 对插件的 Console 入口文件中的路由和菜单定义包含破坏性更新。** 1. 移除 `definePlugin` 方法的 `menus` 字段，改为在 route 的 meta 中定义。 2. 将 `RoutesMenu` 组件从 `@halo-dev/components` 包中移出。 3. 将 `BasicLayout` 组件从 `@halo-dev/console-shared` 包中移出。 定义路由的方式： ```ts import { definePlugin } from "@halo-dev/console-shared"; import BasicLayout from "@/layouts/BasicLayout.vue"; import AttachmentList from "./AttachmentList.vue"; import AttachmentSelectorModal from "./components/AttachmentSelectorModal.vue"; import { IconFolder } from "@halo-dev/components"; import { markRaw } from "vue"; export default definePlugin({ name: "attachmentModule", components: [AttachmentSelectorModal], routes: [ { path: "/attachments", component: BasicLayout, children: [ { path: "", name: "Attachments", component: AttachmentList, meta: { title: "附件", permissions: ["system:attachments:view"], menu: { name: "附件", group: "内容", icon: markRaw(IconFolder), priority: 4, mobile: true, }, }, }, ], }, ], }); ``` menu 字段类型： ```ts interface RouteMeta { title?: string; searchable?: boolean; permissions?: string[]; menu?: { name: string; group?: string; icon?: Component; priority: number; mobile?: true; }; } ``` 插件适配需要做的改动： 1. 移除 `definePlugin` 中的 menus 字段。 2. 在需要添加到菜单的 route 中提供 `meta.menu` 对象，可参考上方的 menu 字段类型。 详细文档可查阅：https://github.com/ruibaby/halo-console/tree/refactor/route-map-setting/docs/routes-generation todolist: - [x] 完善预设的菜单分组定义。 - [x] 绑定权限，根据权限决定是否需要将路由添加到菜单。 - [x] 优化菜单排序的定义方式。 #### Which issue(s) this PR fixes: Fixes https://github.com/halo-dev/halo/issues/2595 #### Special notes for your reviewer: /cc @halo-dev/sig-halo-console 测试方式： 1. 需要 `pnpm build:packages` 2. 测试后台的菜单及路由是否有异常。 3. 新建角色测试路由和菜单对权限的绑定。 4. 按照 https://github.com/ruibaby/halo-console/tree/refactor/route-map-setting/docs/routes-generation 文档，创建插件，测试插件添加路由和菜单是否正常。 #### Does this PR introduce a user-facing change? ```release-note 重构路由和侧边菜单生成的逻辑。 ``` |
||
|---|---|---|
| .changeset | ||
| .github | ||
| .husky | ||
| .vscode | ||
| cypress | ||
| docs | ||
| packages | ||
| public | ||
| src | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.development | ||
| .env.production | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .gitpod.yml | ||
| .npmignore | ||
| .npmrc | ||
| Dockerfile | ||
| LICENSE | ||
| Makefile | ||
| OWNERS | ||
| README.md | ||
| cypress.json | ||
| env.d.ts | ||
| index.html | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| postcss.config.js | ||
| prettier.config.js | ||
| tailwind.config.js | ||
| tsconfig.app.json | ||
| tsconfig.json | ||
| tsconfig.vite-config.json | ||
| tsconfig.vitest.json | ||
| vite.config.ts | ||
| vitest.config.ts | ||
README.md
README
Halo 2.0 的管理端项目（原 halo-admin）
注意
当前分支为 Halo 2.0 的 Console 端开发分支，目前 Halo 2.0 处于 Alpha 测试阶段，不建议从 1.5 直接升级，也不建议在生产环境使用。Console 端稳定版本（Halo 1.5）请查阅以下地址：
- 1.5 分支：https://github.com/halo-dev/console/tree/release-1.5
- 1.6 分支：https://github.com/halo-dev/console/tree/release-1.6
当前仓库已经将
halo-admin改为了console。但对于 Halo 1.x 版本，依旧保持 halo-admin 的概念。
开发环境运行
# pnpm@7.0.0+
npm install -g pnpm
pnpm install
pnpm build:packages
pnpm dev
生产构建
pnpm build
状态
