Skip to content

Commit

Permalink
docs(menu): update docs about routerLink (#4543)
Browse files Browse the repository at this point in the history
* Update menu.md

* Update menu.en-US.md

* chore: update version for en version

Co-authored-by: liweijie0812 <674416404@qq.com>

---------

Co-authored-by: wū yāng <uyarnchen@gmail.com>
Co-authored-by: liweijie0812 <674416404@qq.com>
  • Loading branch information
3 people authored Sep 9, 2024
1 parent 242d65b commit 51e247b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/menu/menu.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ href | String | - | \- | N
icon | Slot / Function | - | Typescript:`TNode`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
replace | Boolean | false | \- | N
router | Object | - | Typescript:`Record<string, any>` | N
routerLink | Boolean | - | `1.3.11`。This API is valid if and only if the Router exists. Enable menu item content to be rendered as an `<a />` consistent with router-link behavior. | N
target | String | _self | options:_blank/_self/_parent/_top | N
to | String / Object | - | Typescript:`MenuRoute` `interface MenuRoute { path?: string; name?: string; hash?: string; query?: MenuQueryData; params?: MenuQueryData }` `type MenuQueryData = { [key: string]: string \| string[] }`[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/menu/type.ts) | N
value | String / Number | - | Typescript:`MenuValue` | N
Expand Down
1 change: 1 addition & 0 deletions src/menu/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ href | String | - | 跳转链接 | N
icon | Slot / Function | - | 图标。TS 类型:`TNode`[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N
replace | Boolean | false | 路由跳转是否采用覆盖的方式(覆盖后将没有浏览器历史记录) | N
router | Object | - | 路由对象。如果项目存在 Router,则默认使用 Router。。TS 类型:`Record<string, any>` | N
routerLink | Boolean | - | `1.3.11`。当且仅当 Router 存在时,该 API 有效。开启菜单项内容渲染为与router-link行为一致的`<a />`标签。 | N
target | String | _self | 链接或路由跳转方式。可选项:_blank/_self/_parent/_top | N
to | String / Object | - | 路由跳转目标,当且仅当 Router 存在时,该 API 有效。TS 类型:`MenuRoute` `interface MenuRoute { path?: string; name?: string; hash?: string; query?: MenuQueryData; params?: MenuQueryData }` `type MenuQueryData = { [key: string]: string \| string[] }`[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/menu/type.ts) | N
value | String / Number | - | 菜单项唯一标识。TS 类型:`MenuValue` | N
Expand Down

0 comments on commit 51e247b

Please sign in to comment.