Skip to content

Commit 9a6c560

Browse files
authored
docs: add doc for Routes (#277)
* docs: add doc for Routes * chore: update * chore: update * chore: update * chore: update
1 parent 282d4fe commit 9a6c560

File tree

4 files changed

+183
-0
lines changed

4 files changed

+183
-0
lines changed

docs/config/handbook.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2280,6 +2280,12 @@ export default [
22802280
},
22812281
],
22822282
},
2283+
{
2284+
title: 'Routes',
2285+
'title.zh-CN': '路由',
2286+
'title.ja-JP': 'ルート',
2287+
link: '/handbook/routes',
2288+
},
22832289
],
22842290
},
22852291
{
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 路由管理器
2+
3+
<PluginInfo name="client"></PluginInfo>
4+
5+
## 介绍
6+
7+
路由管理器是一个用于管理系统主页面路由的工具,支持`桌面端``移动端`。使用路由管理器创建的路由,会同步显示在菜单中(可配置为不显示在菜单中)。反之,在页面菜单处添加的菜单,也会同步显示在路由管理器列表中。
8+
9+
![20250107115449](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250107115449.png)
10+
11+
## 使用手册
12+
13+
### 路由类型
14+
15+
系统支持四种类型的路由:
16+
17+
- 分组(group):用于对路由进行分组管理,可以包含子路由
18+
- 页面(page):系统内部页面
19+
- 标签(tab):用于在页面内部进行标签页切换的路由类型
20+
- 链接(link):内部或者外部链接,可直接跳转到其配置的链接地址
21+
22+
### 添加路由
23+
24+
点击右上角的“Add new”按钮可以创建新的路由:
25+
26+
1. 选择路由类型(Type)
27+
2. 填写路由标题(Title)
28+
3. 选择路由图标(Icon)
29+
4. 设置是否在菜单中显示(Show in menu)
30+
5. 设置是否开启 Tab 页(Enable page tabs)
31+
6. 对于页面类型,系统会自动生成唯一的路由路径(Path)
32+
33+
![20250124131803](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250124131803.png)
34+
35+
### 路由操作
36+
37+
每个路由条目支持以下操作:
38+
39+
- Add child:添加子路由
40+
- Edit:编辑路由配置
41+
- View:查看路由页面
42+
- Delete:删除路由
43+
44+
### 批量操作
45+
46+
顶部工具栏提供以下批量操作功能:
47+
48+
- Refresh:刷新路由列表
49+
- Delete:删除选中的路由
50+
- Hide in menu:在菜单中隐藏选中的路由
51+
- Show in menu:在菜单中显示选中的路由
52+
53+
### 路由筛选
54+
55+
使用顶部的“Filter”功能可以根据需要筛选路由列表。
56+
57+
:::info{title=提示}
58+
路由配置的修改将直接影响系统的导航菜单结构。请谨慎操作,确保路由配置的正确性。
59+
:::
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 路由管理器
2+
3+
<PluginInfo name="client"></PluginInfo>
4+
5+
## 介绍
6+
7+
路由管理器是一个用于管理系统主页面路由的工具,支持`桌面端``移动端`。使用路由管理器创建的路由,会同步显示在菜单中(可配置为不显示在菜单中)。反之,在页面菜单处添加的菜单,也会同步显示在路由管理器列表中。
8+
9+
![20250107115449](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250107115449.png)
10+
11+
## 使用手册
12+
13+
### 路由类型
14+
15+
系统支持四种类型的路由:
16+
17+
- 分组(group):用于对路由进行分组管理,可以包含子路由
18+
- 页面(page):系统内部页面
19+
- 标签(tab):用于在页面内部进行标签页切换的路由类型
20+
- 链接(link):内部或者外部链接,可直接跳转到其配置的链接地址
21+
22+
### 添加路由
23+
24+
点击右上角的“Add new”按钮可以创建新的路由:
25+
26+
1. 选择路由类型(Type)
27+
2. 填写路由标题(Title)
28+
3. 选择路由图标(Icon)
29+
4. 设置是否在菜单中显示(Show in menu)
30+
5. 设置是否开启 Tab 页(Enable page tabs)
31+
6. 对于页面类型,系统会自动生成唯一的路由路径(Path)
32+
33+
![20250124131803](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250124131803.png)
34+
35+
### 路由操作
36+
37+
每个路由条目支持以下操作:
38+
39+
- Add child:添加子路由
40+
- Edit:编辑路由配置
41+
- View:查看路由页面
42+
- Delete:删除路由
43+
44+
### 批量操作
45+
46+
顶部工具栏提供以下批量操作功能:
47+
48+
- Refresh:刷新路由列表
49+
- Delete:删除选中的路由
50+
- Hide in menu:在菜单中隐藏选中的路由
51+
- Show in menu:在菜单中显示选中的路由
52+
53+
### 路由筛选
54+
55+
使用顶部的“Filter”功能可以根据需要筛选路由列表。
56+
57+
:::info{title=提示}
58+
路由配置的修改将直接影响系统的导航菜单结构。请谨慎操作,确保路由配置的正确性。
59+
:::
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 路由管理器
2+
3+
<PluginInfo name="client"></PluginInfo>
4+
5+
## 介绍
6+
7+
路由管理器是一个用于管理系统主页面路由的工具,支持`桌面端``移动端`。使用路由管理器创建的路由,会同步显示在菜单中(可配置为不显示在菜单中)。反之,在页面菜单处添加的菜单,也会同步显示在路由管理器列表中。
8+
9+
![20250107115449](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250107115449.png)
10+
11+
## 使用手册
12+
13+
### 路由类型
14+
15+
系统支持四种类型的路由:
16+
17+
- 分组(group):用于对路由进行分组管理,可以包含子路由
18+
- 页面(page):系统内部页面
19+
- 标签(tab):用于在页面内部进行标签页切换的路由类型
20+
- 链接(link):内部或者外部链接,可直接跳转到其配置的链接地址
21+
22+
### 添加路由
23+
24+
点击右上角的“Add new”按钮可以创建新的路由:
25+
26+
1. 选择路由类型(Type)
27+
2. 填写路由标题(Title)
28+
3. 选择路由图标(Icon)
29+
4. 设置是否在菜单中显示(Show in menu)
30+
5. 设置是否开启 Tab 页(Enable page tabs)
31+
6. 对于页面类型,系统会自动生成唯一的路由路径(Path)
32+
33+
![20250124131803](https://nocobase-docs.oss-cn-beijing.aliyuncs.com/20250124131803.png)
34+
35+
### 路由操作
36+
37+
每个路由条目支持以下操作:
38+
39+
- Add child:添加子路由
40+
- Edit:编辑路由配置
41+
- View:查看路由页面
42+
- Delete:删除路由
43+
44+
### 批量操作
45+
46+
顶部工具栏提供以下批量操作功能:
47+
48+
- Refresh:刷新路由列表
49+
- Delete:删除选中的路由
50+
- Hide in menu:在菜单中隐藏选中的路由
51+
- Show in menu:在菜单中显示选中的路由
52+
53+
### 路由筛选
54+
55+
使用顶部的“Filter”功能可以根据需要筛选路由列表。
56+
57+
:::info{title=提示}
58+
路由配置的修改将直接影响系统的导航菜单结构。请谨慎操作,确保路由配置的正确性。
59+
:::

0 commit comments

Comments
 (0)