Browse Source

docs: update Menu English doc (#7465)

* Update Menu English doc

Fixed typos.

* Update Menu English doc

Accidentally replaced noop with none in previous commit. Now reverted.
pull/7427/merge
Khalifa Lame 7 years ago
committed by Benjy Cui
parent
commit
fa1547df84
  1. 24
      components/menu/index.en-US.md

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

@ -28,21 +28,21 @@ More layouts with navigation: [layout](/components/layout).
| Param | Description | Type | Default value |
|----------|---------------|----------|--------------|
| theme | color of the theme | string: `light` `dark` | `light` |
| mode | type of the menu; vertical, horizontal, and inline modes are supported | string: vertical horizontal inline | vertical |
| theme | color theme of the menu | string: `light` `dark` | `light` |
| mode | type of the menu; `vertical`, `horizontal`, and `inline` modes are supported | string: `vertical` \| `horizontal` \| `inline` | `vertical` |
| selectable | allow selecting menu items | boolean | true |
| selectedKeys | array with the keys of currently selected menu items | string[] | |
| defaultSelectedKeys | array with the keys of default selected menu items | string[] | |
| openKeys | array with the keys of currently opened sub menus | string[] | |
| defaultOpenKeys | array with the keys of default opened sub menus | | |
| onOpenChange | called when open/close sub menu | function(openKeys: string[]) | noop |
| onSelect | callback of the selected item | function({ item, key, selectedKeys }) | none |
| onDeselect | callback of the deselected item, only supported for multiple mode | function({ item, key, selectedKeys }) | - |
| onClick | callback when click menu item, params: {item, key, keyPath} | function({ item, key, keyPath }) | - |
| onSelect | callback executed when a menu item is selected | function({ item, key, selectedKeys }) | none |
| onDeselect | callback executed when a menu item is deselected, only supported for multiple mode | function({ item, key, selectedKeys }) | - |
| onClick | callback executed when a menu item is clicked | function({ item, key, keyPath }) | - |
| style | style of the root node | object | |
| inlineIndent | indent px of inline menu item on each level | number | 24 |
| multiple | Allow select multiple item | boolean | false |
| inlineCollapsed | specified the collapsed status when menu is inline mode | boolean | - |
| multiple | Allow selection of multiple items | boolean | false |
| inlineCollapsed | specifies the collapsed status when menu is inline mode | boolean | - |
| selectable | Allow to be selected | boolean | true |
> More options in [rc-menu](https://github.com/react-component/menu#api)
@ -51,18 +51,18 @@ More layouts with navigation: [layout](/components/layout).
| Param | Description | Type | Default value |
|----------|----------------|----------|--------------|
| disabled | disabled or not | boolean | false |
| disabled | whether menu item is disabled or not | boolean | false |
| key | unique id of the menu item | string | |
### Menu.SubMenu
| Param | Description | Type | Default value |
|----------|----------------|----------|--------------|
| disabled | disabled or not | boolean | false |
| key | unique id of the menu item | string | |
| disabled | whether sub menu is disabled or not | boolean | false |
| key | unique id of the sub menu | string | |
| title | title of the sub menu | string\|ReactNode | |
| children | sub menus or sub menu items | Array<MenuItem\|SubMenu> | |
| onTitleClick | callback of the clicked sub menu title | function({ key, domEvent }) | |
| onTitleClick | callback executed when the sub menu title is clicked | function({ key, domEvent }) | |
### Menu.ItemGroup
@ -73,4 +73,4 @@ More layouts with navigation: [layout](/components/layout).
### Menu.Divider
divider line in between menu items, only used in vertical popup Menu or Dropdown Menu.
Divider line in between menu items, only used in vertical popup Menu or Dropdown Menu.

Loading…
Cancel
Save