Skip to content

Commit 594fd96

Browse files
authored
docs: 优化文档 (WeBankFinTech#187)
1 parent f680a6a commit 594fd96

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

docs/guide/route.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ Fes.js 里约定名称为 `[slug]`格式的文件或文件夹映射为动态路
126126
- `src/pages/users/[id].vue` 会成为 `/users/:id`
127127
- `src/pages/users/[id]/settings.vue` 会成为 `/users/:id/settings`
128128

129-
130129
:::warning
131130
`@slug`形式下版本会弃用,请替换为`[slug]`~
132131
:::
@@ -140,12 +139,10 @@ Fes.js 里约定名称为 `[...slug]`格式的文件或文件夹映射为动态
140139
- `src/pages/users/[...id].vue` 会成为 `/users/:id(.*)`
141140
- `src/pages/users/[...id]/settings.vue` 会成为 `/users/:id(.*)/settings`
142141

143-
144142
:::warning
145143
`*`形式下版本会弃用,请替换为`[...slug]`~
146144
:::
147145

148-
149146
### 嵌套路由
150147

151148
Fes.js 里约定目录下有 `layout.vue` 时会生成嵌套路由,以 `layout.vue` 为该目录的公共父组件,`layout.vue` 中必须实现 `RouterView`
@@ -263,7 +260,7 @@ defineRouteMeta({
263260
```
264261

265262
::: tip
266-
推荐使用`defineRouteMete`,有更好的提示。
263+
推荐使用`defineRouteMeta`,有更好的提示。
267264
:::
268265

269266
路由元信息在编译后会附加到路由配置中:

docs/reference/plugin/plugins/layout.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
可以为页面单独设置布局类型:
5858

5959
```js
60-
import { defineRouteMete } from '@fesjs/fes';
60+
import { defineRouteMeta } from '@fesjs/fes';
6161

6262
defineRouteMeta({
6363
layout: {
@@ -73,7 +73,7 @@ defineRouteMeta({
7373
支持配置页面缓存,通过[定义路由元信息](../../../guide/route.html#扩展路由元信息)开启缓存:
7474

7575
```js
76-
import { defineRouteMete } from '@fesjs/fes';
76+
import { defineRouteMeta } from '@fesjs/fes';
7777

7878
defineRouteMeta({
7979
'keep-alive': true,
@@ -248,16 +248,16 @@ export const layout = (layoutConfig, { initialState }) => ({
248248
```
249249
250250
- **title**:菜单的标题。
251-
252-
- 如果同时使用[国际化插件](./locale.md),而且`title`的值以`$`开头,则使用`$`后面的内容去匹配语言设置。
253-
254-
- title支持配置函数,对应 Fes Design 中 Menu 组件的`label`插槽。仅在运行时配置中支持。
251+
252+
- 如果同时使用[国际化插件](./locale.md),而且`title`的值以`$`开头,则使用`$`后面的内容去匹配语言设置。
253+
254+
- title 支持配置函数,对应 Fes Design 中 Menu 组件的`label`插槽。仅在运行时配置中支持。
255255
256256
- **icon**: 菜单的图标,只一级标题展示图标。
257257
258-
- 图标使用[fes-design icon](https://fes-design-4gvn317r3b6bfe17-1254145788.ap-shanghai.app.tcloudbase.com/zh/components/icon.html),编译时配置使用组件名称,我们会自动引入组件。
258+
- 图标使用[fes-design icon](https://fes-design-4gvn317r3b6bfe17-1254145788.ap-shanghai.app.tcloudbase.com/zh/components/icon.html),编译时配置使用组件名称,我们会自动引入组件。
259259
260-
- 图标使用本地或者远程 svg 图片。
260+
- 图标使用本地或者远程 svg 图片。
261261
262262
```js
263263
{
@@ -357,27 +357,26 @@ export const layout = {
357357
## API
358358
359359
### useTabTitle
360+
360361
类型定义如下:
362+
361363
```ts
362364
function useTabTitle(title: string | Ref<string>): void;
363365
```
364-
365-
366+
366367
当使用多页签模式时,在页面中使用 `useTabTitle` 可以自定义页面标签:
368+
367369
```vue
368370
<script setup>
369371
import { useRoute, useTabTitle } from '@fesjs/fes';
370372

371373
const titleRef = useTabTitle(`详情-${route.params?.id}`);
372374
373375
//如果要更新
374-
titleRef.value = "changed"
376+
titleRef.value = 'changed';
375377
</script>
376378
```
377379
378-
379-
380-
381380
## 4.x 升级到 5.x
382381
383382
1. 个性化 layout 配置改为使用传入 navigation

0 commit comments

Comments
 (0)