docs: 文档更新

mineadmin · Nov 16, 2024 · a0b686c · a0b686c
1 parent 4c4d38d
commit a0b686c
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 35 deletions.
diff --git a/docs/demos/ma-pro-table/index.vue b/docs/demos/ma-pro-table/index.vue
@@ -49,6 +49,7 @@ const options = reactive<MaProTableOptions>({
   },
 
   tableOptions: {
+    adaption: false,
     pagination: {
       total: 1000,
     }

diff --git a/docs/zh/front/advanced/permission.md b/docs/zh/front/advanced/permission.md
@@ -3,7 +3,7 @@
 
 ## 概括
 :::tip 权限概括
-路由页面可否访问是基于后端返回的菜单确定的，而静态路由暂无权限控制（后面会增加**前端**对静态路由的控制）。而前端目前主要控制了
+路由页面可否访问是基于后端返回的菜单确定的，而静态路由前端来控制是否可以访问。而前端目前主要控制了
 `内容` 是否可显示`(v-show)`以及渲染`(v-if)`，内容包括了：
 - 页面的元素
 - 页面的组件
@@ -124,4 +124,17 @@ import hasUser from '@/utils/permission/hasUser'
     </template>
   </ma-auth>
 </template>
-```
+```
+
+## 静态路由访问控制
+
+静态路由访问控制只包括带组件页面的路由，不包含按钮之类的，按钮之类的应该通过上面的方式来控制。
+
+::: tip 使用说明
+使用静态路由访问控制十分简单，只需要在路由 `meta` 属性配置上 `auth`、`role` 或 `user` 属性。前端在路由跳转时会进行检查是否可以访问。
+检查不通过，则显示 `403页面`，检查通过则正常访问。如果不需要访问控制，不配置这些属性或将值设置为 `[]` 即可。
+
+
+注意：三个属性的类型都为 `string[]`
+:::
+
diff --git a/docs/zh/front/base/route-menu.md b/docs/zh/front/base/route-menu.md
@@ -12,9 +12,6 @@
 ::: tip 未来构想
 其实，本来可以做成`文件路由`模式，即**文件就是路由**。但目前没有在 `MineAdmin` 内匹配到合适的场景，
 或许未来哪天可能就加入文件路由系统了。
-
-
-另外，在未来小版本更新中，可能会加入**前端权限控制**，就是说，静态路由也可以通过权限控制来控制是否注册或者显示路由。
 :::
 
 ### 动态路由
@@ -184,18 +181,18 @@ const routes = [
 - 类型：`string[]`
 - 默认值：`[]`
 
-用于路由可由那些权限访问，注：还未完成，后续小版本更新加入。
+用于路由可由那些权限访问
 
 #### role
 
 - 类型：`string[]`
 - 默认值：`[]`
 
-用于路由可由那些角色访问，注：还未完成，后续小版本更新加入。
+用于路由可由那些角色访问
 
 #### user
 
 - 类型：`string[]`
 - 默认值：`[]`
 
-用于路由可由那些用户访问，注：还未完成，后续小版本更新加入。
+用于路由可由那些用户访问
diff --git a/docs/zh/front/component/ma-pro-table.md b/docs/zh/front/component/ma-pro-table.md
@@ -302,16 +302,19 @@ add({
 | `searchAfterActions`        | 搜索 `操作按钮` 后置内容插槽                                         | -  |
 
 ## Expose
-| 名称                | 说明                    | 参数                                                              | 返回值                   |
-|-------------------|-----------------------|-----------------------------------------------------------------|-----------------------|
-| `getSearchRef()`  | 获取 `ma-search` 的Ref   | -                                                               | `MaSearchExpose`      |
-| `getTableRef()`  | 获取 `ma-table` 的Ref    | -                                                               | `MaTableExpose`       |
-| `refresh()`  | 刷新表格数据                | `() => Promise<void>`                                           | `Promise<void>`       |
-| `requestData()`  | 请求表格数据                | `() => Promise<void>`                                           | `Promise<void>`       |
-| `changeApi()`  | 变更请求api               | `( api: () => any, isRequestNow: boolean ) => void`             | `void`                |
-| `setRequestParams()`  | 设置请求参数                | `( params: Record<string, any>, isRequestNow: boolean) => void` | `void`                |
-| `setSearchForm()`    | 设置搜索表单默认值             | `(form: Record<string, any>) => void`                           | `void`                |
-| `getSearchForm()`    | 获取搜索表单数据              | `() => Record<string, any>`                                     | `Record<string, any>`                |
-| `getProTableOptions()`    | 获取 `ma-pro-table` 的参数 | `() => Record<string, any>`                                     | `Record<string, any>`                |
-| `resizeHeight()`    | 重置表格高度                | `() => Promise<void>`                                           | `Promise<void>`                |
-| `getCurrentId()`    | 获取当前组件ID              | -                                                               | `string`                |**
+| 名称                     | 说明                    | 参数                                                              | 返回值                   |
+|------------------------|-----------------------|-----------------------------------------------------------------|-----------------------|
+| `getSearchRef()`       | 获取 `ma-search` 的Ref   | -                                                               | `MaSearchExpose`      |
+| `getTableRef()`        | 获取 `ma-table` 的Ref    | -                                                               | `MaTableExpose`       |
+| `setTableColumns()`    | 设置表格列                 | `(cols: MaProTableColumns[]) => void`                           | `void`                |
+| `getTableColumns()`    | 获取表格列                 | `() => MaProTableColumns[]`                                     | `MaProTableColumns[]`                |
+| `refresh()`            | 刷新表格数据                | `() => Promise<void>`                                           | `Promise<void>`       |
+| `requestData()`        | 请求表格数据                | `() => Promise<void>`                                           | `Promise<void>`       |
+| `changeApi()`          | 变更请求api               | `( api: () => any, isRequestNow: boolean ) => void`             | `void`                |
+| `setRequestParams()`   | 设置请求参数                | `( params: Record<string, any>, isRequestNow: boolean) => void` | `void`                |
+| `setSearchForm()`      | 设置搜索表单默认值             | `(form: Record<string, any>) => void`                           | `void`                |
+| `getSearchForm()`      | 获取搜索表单数据              | `() => Record<string, any>`                                     | `Record<string, any>` |
+| `setProTableOptions()` | 设置 `ma-pro-table` 的参数 | `(opts: MaProTableOptions) => void`                             | `void`                |
+| `getProTableOptions()` | 获取 `ma-pro-table` 的参数 | `() => MaProTableOptions`                                       | `MaProTableOptions` |
+| `resizeHeight()`       | 重置表格高度                | `() => Promise<void>`                                           | `Promise<void>`       |
+| `getCurrentId()`       | 获取当前组件ID              | -                                                               | `string`              |**
diff --git a/docs/zh/front/high/plugins.md b/docs/zh/front/high/plugins.md
@@ -151,8 +151,8 @@ const pluginConfig: Plugin.PluginConfig = {
     getUserInfo: (userInfo) => {},
     // 在系统注册路由时被调用，传入了 `vue-router` 实例和路由原始数据。
     registerRoute: (router: Router, routesRaw) => {},
-    // 在页面跳转时被调用，传入了当前路由的数据。
-    routerRedirect: (route: RouteRecordRaw) => {},
+    // 在页面跳转时被调用，传入了原路由和新路由的数据、以及 `vue-router` 实例。注意：外链不生效
+    routerRedirect: ({ oldRoute: RouteRecordRaw, newRoute: RouteRecordRaw }, router: Router) => {},
     // 在网络请求时被调用，传入了原始的请求数据，可对数据加密之类的
     networkRequest: (request) => {},
     // 在服务器返回数据后被调用，传入了原始的响应数据。

diff --git a/package.json b/package.json
@@ -9,8 +9,8 @@
     "@imengyu/vue3-context-menu": "^1.4.2",
     "@mineadmin/echarts": "^1.0.1",
     "@mineadmin/form": "^1.0.21",
-    "@mineadmin/pro-table": "^1.0.25",
-    "@mineadmin/search": "^1.0.21",
+    "@mineadmin/pro-table": "^1.0.31",
+    "@mineadmin/search": "^1.0.23",
     "@mineadmin/table": "^1.0.29",
     "@vueuse/core": "^11.1.0",
     "@vueuse/integrations": "^11.1.0",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml