2022-10-09 06:56:33 +00:00
|
|
|
import { definePlugin } from "@halo-dev/console-shared";
|
2023-07-12 06:19:15 +00:00
|
|
|
import SystemSettings from "./SystemSettings.vue";
|
2022-06-17 06:12:15 +00:00
|
|
|
import { IconSettings } from "@halo-dev/components";
|
refactor: router and menu generation (halo-dev/console#651)
#### 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
重构路由和侧边菜单生成的逻辑。
```
2022-10-19 08:54:13 +00:00
|
|
|
import { markRaw } from "vue";
|
2023-11-09 06:56:06 +00:00
|
|
|
import BasicLayout from "@console/layouts/BasicLayout.vue";
|
2022-06-17 06:12:15 +00:00
|
|
|
|
2022-06-17 07:00:14 +00:00
|
|
|
export default definePlugin({
|
2022-11-30 14:51:49 +00:00
|
|
|
components: {},
|
2022-06-17 06:12:15 +00:00
|
|
|
routes: [
|
|
|
|
{
|
|
|
|
path: "/settings",
|
Refactor menu generation strategy to support sub-menu items. (#5177)
#### What type of PR is this?
/area console
/kind feature
/milestone 2.12.x
#### What this PR does / why we need it:
重构 Console 和 UC 的菜单生成逻辑,支持配置二级菜单项。
<img width="557" alt="图片" src="https://github.com/halo-dev/halo/assets/21301288/0f1717ce-bd30-448b-9625-24bfd5e1c5ae">
配置方式:
```ts
export default definePlugin({
components: {},
routes: [
{
parentName: "AttachmentsRoot",
route: {
name: "S3Link",
path: "s3-link",
component: markRaw(HomeView),
meta: {
title: "S3 关联",
searchable: true,
menu: {
name: "S3 关联",
icon: markRaw(IconAddCircle),
priority: 0,
mobile: true,
},
},
},
},
],
});
```
只需要指定 parentName 并在其下 route 需要配置 meta.menu 即可。
最终文档会补充在:https://github.com/halo-dev/docs/pull/291
#### Which issue(s) this PR fixes:
Fixes https://github.com/halo-dev/halo/issues/4807
#### Special notes for your reviewer:
1. 可以按照上述配置方式测试。
2. 可以安装 [plugin-s3-1.5.0-SNAPSHOT.jar.zip](https://github.com/halo-dev/halo/files/13959977/plugin-s3-1.5.0-SNAPSHOT.jar.zip) 进行测试。
#### Does this PR introduce a user-facing change?
```release-note
重构 Console 和 UC 的菜单生成逻辑,支持配置二级菜单项。
```
2024-01-19 05:34:10 +00:00
|
|
|
name: "SettingsRoot",
|
2023-07-12 06:19:15 +00:00
|
|
|
component: BasicLayout,
|
Refactor menu generation strategy to support sub-menu items. (#5177)
#### What type of PR is this?
/area console
/kind feature
/milestone 2.12.x
#### What this PR does / why we need it:
重构 Console 和 UC 的菜单生成逻辑,支持配置二级菜单项。
<img width="557" alt="图片" src="https://github.com/halo-dev/halo/assets/21301288/0f1717ce-bd30-448b-9625-24bfd5e1c5ae">
配置方式:
```ts
export default definePlugin({
components: {},
routes: [
{
parentName: "AttachmentsRoot",
route: {
name: "S3Link",
path: "s3-link",
component: markRaw(HomeView),
meta: {
title: "S3 关联",
searchable: true,
menu: {
name: "S3 关联",
icon: markRaw(IconAddCircle),
priority: 0,
mobile: true,
},
},
},
},
],
});
```
只需要指定 parentName 并在其下 route 需要配置 meta.menu 即可。
最终文档会补充在:https://github.com/halo-dev/docs/pull/291
#### Which issue(s) this PR fixes:
Fixes https://github.com/halo-dev/halo/issues/4807
#### Special notes for your reviewer:
1. 可以按照上述配置方式测试。
2. 可以安装 [plugin-s3-1.5.0-SNAPSHOT.jar.zip](https://github.com/halo-dev/halo/files/13959977/plugin-s3-1.5.0-SNAPSHOT.jar.zip) 进行测试。
#### Does this PR introduce a user-facing change?
```release-note
重构 Console 和 UC 的菜单生成逻辑,支持配置二级菜单项。
```
2024-01-19 05:34:10 +00:00
|
|
|
meta: {
|
|
|
|
title: "core.setting.title",
|
|
|
|
permissions: ["system:settings:view"],
|
|
|
|
menu: {
|
|
|
|
name: "core.sidebar.menu.items.settings",
|
|
|
|
group: "system",
|
|
|
|
icon: markRaw(IconSettings),
|
|
|
|
priority: 2,
|
|
|
|
},
|
|
|
|
},
|
2022-06-17 06:12:15 +00:00
|
|
|
children: [
|
|
|
|
{
|
2023-07-12 06:19:15 +00:00
|
|
|
path: "",
|
2022-09-06 07:22:37 +00:00
|
|
|
name: "SystemSetting",
|
2023-07-12 06:19:15 +00:00
|
|
|
component: SystemSettings,
|
2022-06-17 06:12:15 +00:00
|
|
|
},
|
|
|
|
],
|
|
|
|
},
|
|
|
|
],
|
2022-06-17 07:00:14 +00:00
|
|
|
});
|