Skip to content

Commit 7786a81

Browse files
jiaowoxiaobalajiaowoxiaobala
authored
docs(menu): fix typo (#7025)
1 parent 6f89185 commit 7786a81

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

‎components/menu/index.en-US.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ More layouts with navigation: [Layout](/components/layout).
3333
| items | Menu item content | [ItemType\[\]](#ItemType) | - | 4.20.0 |
3434
| mode | type of the menu; `vertical`, `horizontal`, and `inline` modes are supported | `vertical` \| `horizontal` \| `inline` | `vertical` |
3535
| multiple | Allow selection of multiple items | boolean | false |
36-
| openKeys(v-model) | array with the keys of currently opened sub menus | string\[] | |
36+
| openKeys(v-model) | array with the keys of currently opened sub menus | (string \| number)[] | |
3737
| overflowedIndicator | Customized the ellipsis icon when menu is collapsed horizontally | slot | `<EllipsisOutlined />` |
3838
| selectable | allow selecting menu items | boolean | true |
39-
| selectedKeys(v-model) | array with the keys of currently selected menu items | string\[] | |
39+
| selectedKeys(v-model) | array with the keys of currently selected menu items | (string \| number)[] | |
4040
| style | style of the root node | object | |
4141
| subMenuCloseDelay | delay time to hide submenu when mouse leave, unit: second | number | 0.1 |
4242
| subMenuOpenDelay | delay time to show submenu when mouse enter, unit: second | number | 0 |
@@ -49,15 +49,15 @@ More layouts with navigation: [Layout](/components/layout).
4949
| --- | --- | --- |
5050
| click | callback executed when a menu item is clicked | function({ item, key, keyPath }) |
5151
| deselect | callback executed when a menu item is deselected, only supported for multiple mode | function({ item, key, selectedKeys }) |
52-
| openChange | called when open/close sub menu | function(openKeys: string\[]) |
52+
| openChange | called when open/close sub menu | function(openKeys: (string \| number)[]) |
5353
| select | callback executed when a menu item is selected | function({ item, key, selectedKeys }) |
5454

5555
### Menu.Item
5656

5757
| Param | Description | Type | Default value |
5858
| -------- | ------------------------------------ | -------------- | ------------- |
5959
| disabled | whether menu item is disabled or not | boolean | false |
60-
| key | unique id of the menu item | string | |
60+
| key | unique id of the menu item | string \| number | |
6161
| title | set display title for collapsed item | string \| slot | |
6262

6363
### ItemType
@@ -71,7 +71,7 @@ More layouts with navigation: [Layout](/components/layout).
7171
| danger | Display the danger style | boolean | false | |
7272
| disabled | Whether menu item is disabled | boolean | false | |
7373
| icon | The icon of the menu item | VueNode \| (item: MenuItemType) => VNode | - | |
74-
| key | Unique ID of the menu item | string | - | |
74+
| key | Unique ID of the menu item | string \| number | - | |
7575
| label | Menu label | VueNode | - | |
7676
| title | Set display title for collapsed item | string | - | |
7777

@@ -83,7 +83,7 @@ More layouts with navigation: [Layout](/components/layout).
8383
| children | Sub-menus or sub-menu items | [ItemType\[\]](#ItemType) | - | |
8484
| disabled | Whether sub-menu is disabled | boolean | false | |
8585
| icon | Icon of sub menu | VueNode \| (item: SubMenuType) => VueNode | - | |
86-
| key | Unique ID of the sub-menu | string | - | |
86+
| key | Unique ID of the sub-menu | string \| number | - | |
8787
| label | Menu label | VueNode | - | |
8888
| popupClassName | Sub-menu class name, not working when `mode="inline"` | string | - | |
8989
| popupOffset | Sub-menu offset, not working when `mode="inline"` | \[number, number] | - | |
@@ -127,7 +127,7 @@ const dividerItem = {
127127
| --- | --- | --- | --- | --- |
128128
| disabled | whether sub menu is disabled or not | boolean | false | |
129129
| expandIcon | Customized expandIcon | slot | arrow icon | ｜ |
130-
| key | Unique ID of the sub menu, required | string | | |
130+
| key | Unique ID of the sub menu, required | string \| number | | |
131131
| popupClassName | Sub-menu class name | string | | 1.5.0 |
132132
| popupOffset | Sub-menu offset, not working when `mode="inline"` | \[number, number] | - | |
133133
| title | title of the sub menu | string\|slot | | |

‎components/menu/index.zh-CN.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAA
3434
| items | 菜单内容 | [ItemType\[\]](#ItemType) | - | |
3535
| mode | 菜单类型，现在支持垂直、水平、和内嵌模式三种 | `vertical` \| `horizontal` \| `inline` | `vertical` |
3636
| multiple | 是否允许多选 | boolean | false |
37-
| openKeys(v-model) | 当前展开的 SubMenu 菜单项 key 数组 | string\[] | |
37+
| openKeys(v-model) | 当前展开的 SubMenu 菜单项 key 数组 | (string \| number)[] | |
3838
| overflowedIndicator | 用于自定义 Menu 水平空间不足时的省略收缩的图标 | slot | `<EllipsisOutlined />` |
3939
| selectable | 是否允许选中 | boolean | true |
40-
| selectedKeys(v-model) | 当前选中的菜单项 key 数组 | string\[] | |
40+
| selectedKeys(v-model) | 当前选中的菜单项 key 数组 | (string \| number)[] | |
4141
| subMenuCloseDelay | 用户鼠标离开子菜单后关闭延时，单位：秒 | number | 0.1 |
4242
| subMenuOpenDelay | 用户鼠标进入子菜单后开启延时，单位：秒 | number | 0 |
4343
| theme | 主题颜色 | `light` \| `dark` | `light` |
@@ -49,7 +49,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAA
4949
| ---------- | ---------------------------------- | ------------------------------------- |
5050
| click | 点击 MenuItem 调用此函数 | function({ item, key, keyPath }) |
5151
| deselect | 取消选中时调用，仅在 multiple 生效 | function({ item, key, selectedKeys }) |
52-
| openChange | SubMenu 展开/关闭的回调 | function(openKeys: string\[]) |
52+
| openChange | SubMenu 展开/关闭的回调 | function(openKeys: (string \| number)[]) |
5353
| select | 被选中时调用 | function({ item, key, selectedKeys }) |
5454

5555
### Menu.Item
@@ -58,7 +58,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAA
5858
| -------- | ------------------------ | -------------- | ------ | ----- |
5959
| disabled | 是否禁用 | boolean | false | |
6060
| icon | 菜单图标 | slot | | 2.8.0 |
61-
| key | item 的唯一标志 | string | | |
61+
| key | item 的唯一标志 | string \| number | | |
6262
| title | 设置收缩时展示的悬浮标题 | string \| slot | | |
6363

6464
### ItemType
@@ -72,7 +72,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAA
7272
| danger | 展示错误状态样式 | boolean | false | |
7373
| disabled | 是否禁用 | boolean | false | |
7474
| icon | 菜单图标 | VueNode\|(item: MenuItemType)=>VueNode | - | |
75-
| key | item 的唯一标志 | string | - | |
75+
| key | item 的唯一标志 | string \| number | - | |
7676
| label | 菜单项标题 | VueNode | - | |
7777
| title | 设置收缩时展示的悬浮标题 | string | - | |
7878

@@ -83,7 +83,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAA
8383
| children | 子菜单的菜单项 | [ItemType\[\]](#ItemType) | - | |
8484
| disabled | 是否禁用 | boolean | false | |
8585
| icon | 菜单图标 | VueNode\|(item: SubMenuType)=>VueNode | - | |
86-
| key | 唯一标志 | string | - | |
86+
| key | 唯一标志 | string \| number | - | |
8787
| label | 菜单项标题 | VueNode | - | |
8888
| popupClassName | 子菜单样式，`mode="inline"` 时无效 | string | - | |
8989
| popupOffset | 子菜单偏移量，`mode="inline"` 时无效 | \[number, number] | - | |
@@ -128,7 +128,7 @@ const dividerItem = {
128128
| disabled | 是否禁用 | boolean | false | |
129129
| expandIcon | 自定义 Menu 展开收起图标 | slot | 箭头图标 | |
130130
| icon | 菜单图标 | slot | | 2.8.0 |
131-
| key | 唯一标志, 必填 | string | | |
131+
| key | 唯一标志, 必填 | string \| number | | |
132132
| popupClassName | 子菜单样式 | string | | 1.5.0 |
133133
| popupOffset | 子菜单偏移量，`mode="inline"` 时无效 | \[number, number] | - | |
134134
| title | 子菜单项值 | string\|slot | | |

‎components/menu/src/interface.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface SubMenuType extends ItemSharedProps {
1515

1616
disabled?: boolean;
1717

18-
key: string;
18+
key: Key;
1919
theme?: MenuTheme;
2020
rootClassName?: string;
2121

0 commit comments

Comments
 (0)