docs: 优化文档 (#187)

This commit is contained in:
qlin 2023-04-12 16:03:07 +08:00 committed by GitHub
parent f680a6a51c
commit 594fd966df
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 18 deletions

View File

@ -126,7 +126,6 @@ Fes.js 里约定名称为 `[slug]`格式的文件或文件夹映射为动态路
- `src/pages/users/[id].vue` 会成为 `/users/:id`
- `src/pages/users/[id]/settings.vue` 会成为 `/users/:id/settings`
:::warning
`@slug`形式下版本会弃用,请替换为`[slug]`~
:::
@ -140,12 +139,10 @@ Fes.js 里约定名称为 `[...slug]`格式的文件或文件夹映射为动态
- `src/pages/users/[...id].vue` 会成为 `/users/:id(.*)`
- `src/pages/users/[...id]/settings.vue` 会成为 `/users/:id(.*)/settings`
:::warning
`*`形式下版本会弃用,请替换为`[...slug]`~
:::
### 嵌套路由
Fes.js 里约定目录下有 `layout.vue` 时会生成嵌套路由,以 `layout.vue` 为该目录的公共父组件,`layout.vue` 中必须实现 `RouterView`
@ -263,7 +260,7 @@ defineRouteMeta({
```
::: tip
推荐使用`defineRouteMete`,有更好的提示。
推荐使用`defineRouteMeta`,有更好的提示。
:::
路由元信息在编译后会附加到路由配置中:

View File

@ -57,7 +57,7 @@
可以为页面单独设置布局类型:
```js
import { defineRouteMete } from '@fesjs/fes';
import { defineRouteMeta } from '@fesjs/fes';
defineRouteMeta({
layout: {
@ -73,7 +73,7 @@ defineRouteMeta({
支持配置页面缓存,通过[定义路由元信息](../../../guide/route.html#扩展路由元信息)开启缓存:
```js
import { defineRouteMete } from '@fesjs/fes';
import { defineRouteMeta } from '@fesjs/fes';
defineRouteMeta({
'keep-alive': true,
@ -248,16 +248,16 @@ export const layout = (layoutConfig, { initialState }) => ({
```
- **title**:菜单的标题。
- 如果同时使用[国际化插件](./locale.md),而且`title`的值以`$`开头,则使用`$`后面的内容去匹配语言设置。
- title支持配置函数对应 Fes Design 中 Menu 组件的`label`插槽。仅在运行时配置中支持。
- 如果同时使用[国际化插件](./locale.md),而且`title`的值以`$`开头,则使用`$`后面的内容去匹配语言设置。
- title 支持配置函数,对应 Fes Design 中 Menu 组件的`label`插槽。仅在运行时配置中支持。
- **icon**: 菜单的图标,只一级标题展示图标。
- 图标使用[fes-design icon](https://fes-design-4gvn317r3b6bfe17-1254145788.ap-shanghai.app.tcloudbase.com/zh/components/icon.html),编译时配置使用组件名称,我们会自动引入组件。
- 图标使用[fes-design icon](https://fes-design-4gvn317r3b6bfe17-1254145788.ap-shanghai.app.tcloudbase.com/zh/components/icon.html),编译时配置使用组件名称,我们会自动引入组件。
- 图标使用本地或者远程 svg 图片。
- 图标使用本地或者远程 svg 图片。
```js
{
@ -357,13 +357,15 @@ export const layout = {
## API
### useTabTitle
类型定义如下:
```ts
function useTabTitle(title: string | Ref<string>): void;
```
当使用多页签模式时,在页面中使用 `useTabTitle` 可以自定义页面标签:
```vue
<script setup>
import { useRoute, useTabTitle } from '@fesjs/fes';
@ -371,13 +373,10 @@ import { useRoute, useTabTitle } from '@fesjs/fes';
const titleRef = useTabTitle(`详情-${route.params?.id}`);
//如果要更新
titleRef.value = "changed"
titleRef.value = 'changed';
</script>
```
## 4.x 升级到 5.x
1. 个性化 layout 配置改为使用传入 navigation