mirror of
https://github.com/WeBankFinTech/fes.js.git
synced 2025-04-06 03:59:53 +08:00
docs: 完善文档
This commit is contained in:
parent
ad52cad5a3
commit
b05c98c0d7
@ -70,6 +70,15 @@ plugin.applyPlugins({
|
|||||||
|
|
||||||
Fes.js 路由基于 [Vue Router 4.0](https://next.router.vuejs.org/introduction.html),想了解更多的同学可以看看官方文档。
|
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
|
### useRoute
|
||||||
返回当前 `route` 实例,相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。
|
返回当前 `route` 实例,相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。
|
||||||
```js
|
```js
|
||||||
|
@ -13,7 +13,14 @@
|
|||||||
- 可配置页面是否需要 layout。
|
- 可配置页面是否需要 layout。
|
||||||
|
|
||||||
## 布局类型
|
## 布局类型
|
||||||
默认是 `side`
|
配置参数是 `navigation`, 内容默认是 `side`:
|
||||||
|
```js
|
||||||
|
export default {
|
||||||
|
layout: {
|
||||||
|
navigation: 'side
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### side
|
### side
|
||||||
<!--  -->
|
<!--  -->
|
||||||
@ -56,9 +63,20 @@ Fes.js 渲染路由时,如果路由元信息存在配置 `layout` 为 `false`
|
|||||||
```js
|
```js
|
||||||
export default {
|
export default {
|
||||||
layout: {
|
layout: {
|
||||||
|
// 标题
|
||||||
title: "Fes.js",
|
title: "Fes.js",
|
||||||
|
// 底部文字
|
||||||
footer: 'Created by MumbelFe',
|
footer: 'Created by MumbelFe',
|
||||||
|
// 是否开启 tabs
|
||||||
multiTabs: false,
|
multiTabs: false,
|
||||||
|
// 布局类型
|
||||||
|
navigation: 'side',
|
||||||
|
// 是否固定头部
|
||||||
|
fixedHeader: false,
|
||||||
|
// 是否固定sidebar
|
||||||
|
fixedSideBar: true,
|
||||||
|
// sidebar的宽度
|
||||||
|
sideWidth: 200,
|
||||||
menus: [{
|
menus: [{
|
||||||
name: 'index'
|
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
|
#### title
|
||||||
- **类型**:`String`
|
- **类型**:`String`
|
||||||
|
|
||||||
|
@ -70,6 +70,15 @@ plugin.applyPlugins({
|
|||||||
|
|
||||||
Fes.js 路由基于 [Vue Router 4.0](https://next.router.vuejs.org/introduction.html),想了解更多的同学可以看看官方文档。
|
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
|
### useRoute
|
||||||
返回当前 `route` 实例,相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。
|
返回当前 `route` 实例,相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。
|
||||||
```js
|
```js
|
||||||
|
@ -13,7 +13,14 @@
|
|||||||
- 可配置页面是否需要 layout。
|
- 可配置页面是否需要 layout。
|
||||||
|
|
||||||
## 布局类型
|
## 布局类型
|
||||||
默认是 `side`
|
配置参数是 `navigation`, 内容默认是 `side`:
|
||||||
|
```js
|
||||||
|
export default {
|
||||||
|
layout: {
|
||||||
|
navigation: 'side
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### side
|
### side
|
||||||
<!--  -->
|
<!--  -->
|
||||||
@ -56,9 +63,20 @@ Fes.js 渲染路由时,如果路由元信息存在配置 `layout` 为 `false`
|
|||||||
```js
|
```js
|
||||||
export default {
|
export default {
|
||||||
layout: {
|
layout: {
|
||||||
|
// 标题
|
||||||
title: "Fes.js",
|
title: "Fes.js",
|
||||||
|
// 底部文字
|
||||||
footer: 'Created by MumbelFe',
|
footer: 'Created by MumbelFe',
|
||||||
|
// 是否开启 tabs
|
||||||
multiTabs: false,
|
multiTabs: false,
|
||||||
|
// 布局类型
|
||||||
|
navigation: 'side',
|
||||||
|
// 是否固定头部
|
||||||
|
fixedHeader: false,
|
||||||
|
// 是否固定sidebar
|
||||||
|
fixedSideBar: true,
|
||||||
|
// sidebar的宽度
|
||||||
|
sideWidth: 200,
|
||||||
menus: [{
|
menus: [{
|
||||||
name: 'index'
|
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
|
#### title
|
||||||
- **类型**:`String`
|
- **类型**:`String`
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user