From b05c98c0d752725e1ee288f32a8fb4345bdea728 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=87=E7=BA=AF?= Date: Thu, 11 Mar 2021 16:19:13 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=AE=8C=E5=96=84=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/reference/api/README.md | 9 ++++ docs/reference/plugin/plugins/layout.md | 48 +++++++++++++++++++++- docs/zh/reference/api/README.md | 9 ++++ docs/zh/reference/plugin/plugins/layout.md | 48 +++++++++++++++++++++- 4 files changed, 112 insertions(+), 2 deletions(-) diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md index 74469259..47c7b8ad 100644 --- a/docs/reference/api/README.md +++ b/docs/reference/api/README.md @@ -70,6 +70,15 @@ plugin.applyPlugins({ Fes.js 路由基于 [Vue Router 4.0](https://next.router.vuejs.org/introduction.html)，想了解更多的同学可以看看官方文档。 +### getRouter +返回当前 `router` 实例。 +```js +import { getRouter } from "@fesjs/fes"; + +const router = getRouter(); +router.push(); +``` + ### useRoute 返回当前 `route` 实例，相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。 ```js diff --git a/docs/reference/plugin/plugins/layout.md b/docs/reference/plugin/plugins/layout.md index bee4fad7..e0511b54 100644 --- a/docs/reference/plugin/plugins/layout.md +++ b/docs/reference/plugin/plugins/layout.md @@ -13,7 +13,14 @@ - 可配置页面是否需要 layout。 ## 布局类型 -默认是 `side` +配置参数是 `navigation`, 内容默认是 `side`： +```js +export default { + layout: { + navigation: 'side + } +} +``` ### side @@ -56,9 +63,20 @@ Fes.js 渲染路由时，如果路由元信息存在配置 `layout` 为 `false` ```js export default { layout: { + // 标题 title: "Fes.js", + // 底部文字 footer: 'Created by MumbelFe', + // 是否开启 tabs multiTabs: false, + // 布局类型 + navigation: 'side', + // 是否固定头部 + fixedHeader: false, + // 是否固定sidebar + fixedSideBar: true, + // sidebar的宽度 + sideWidth: 200, menus: [{ name: 'index' }, { @@ -71,6 +89,34 @@ export default { }, ``` +### footer +- **类型**：`String` + +- **默认值**：`null` + +- **详情**：页面底部的文字。 + +### navigation +- **类型**：`String` + +- **默认值**：`side` + +- **详情**：页面布局类型，可选有 `side`、 `top`、 `mixin` + +### fixedHeader +- **类型**：`Boolean` + +- **默认值**：`false` + +- **详情**：是否固定头部，不跟随页面滚动。 + +### fixedSideBar +- **类型**：`Boolean` + +- **默认值**：`true` + +- **详情**：是否固定sidebar，不跟随页面滚动。 + #### title - **类型**：`String` diff --git a/docs/zh/reference/api/README.md b/docs/zh/reference/api/README.md index 74469259..47c7b8ad 100644 --- a/docs/zh/reference/api/README.md +++ b/docs/zh/reference/api/README.md @@ -70,6 +70,15 @@ plugin.applyPlugins({ Fes.js 路由基于 [Vue Router 4.0](https://next.router.vuejs.org/introduction.html)，想了解更多的同学可以看看官方文档。 +### getRouter +返回当前 `router` 实例。 +```js +import { getRouter } from "@fesjs/fes"; + +const router = getRouter(); +router.push(); +``` + ### useRoute 返回当前 `route` 实例，相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。 ```js diff --git a/docs/zh/reference/plugin/plugins/layout.md b/docs/zh/reference/plugin/plugins/layout.md index bee4fad7..e0511b54 100644 --- a/docs/zh/reference/plugin/plugins/layout.md +++ b/docs/zh/reference/plugin/plugins/layout.md @@ -13,7 +13,14 @@ - 可配置页面是否需要 layout。 ## 布局类型 -默认是 `side` +配置参数是 `navigation`, 内容默认是 `side`： +```js +export default { + layout: { + navigation: 'side + } +} +``` ### side @@ -56,9 +63,20 @@ Fes.js 渲染路由时，如果路由元信息存在配置 `layout` 为 `false` ```js export default { layout: { + // 标题 title: "Fes.js", + // 底部文字 footer: 'Created by MumbelFe', + // 是否开启 tabs multiTabs: false, + // 布局类型 + navigation: 'side', + // 是否固定头部 + fixedHeader: false, + // 是否固定sidebar + fixedSideBar: true, + // sidebar的宽度 + sideWidth: 200, menus: [{ name: 'index' }, { @@ -71,6 +89,34 @@ export default { }, ``` +### footer +- **类型**：`String` + +- **默认值**：`null` + +- **详情**：页面底部的文字。 + +### navigation +- **类型**：`String` + +- **默认值**：`side` + +- **详情**：页面布局类型，可选有 `side`、 `top`、 `mixin` + +### fixedHeader +- **类型**：`Boolean` + +- **默认值**：`false` + +- **详情**：是否固定头部，不跟随页面滚动。 + +### fixedSideBar +- **类型**：`Boolean` + +- **默认值**：`true` + +- **详情**：是否固定sidebar，不跟随页面滚动。 + #### title - **类型**：`String`