Browse Source

improve Menu API document, close #1586

pull/1606/head
afc163 9 years ago
parent
commit
8b417b511c
  1. 26
      components/menu/index.md

26
components/menu/index.md

@ -28,17 +28,21 @@ english: Menu
### Menu props
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
| theme | 主题颜色 | enum: `light` `dark` | 'light' |
| mode | 菜单类型,现在支持垂直、水平、和内嵌模式三种 | enum: `vertical` `horizontal` `inline` | vertical |
| selectedKeys | 当前选中的菜单项 key 数组 | | |
| defaultSelectedKeys | 初始选中的菜单项 key 数组 | | |
| openKeys | 当前展开的菜单项 key 数组 | | |
| defaultOpenKeys | 初始展开的菜单项 key 数组 | | |
| onSelect | 被选中时调用,参数 {item, key, selectedKeys} 对象 | function | 无 |
| onDeselect | 取消选中时调用,参数 {item, key, selectedKeys} 对象,仅在 multiple 生效 | function | 无 |
| onClick | 点击 menuitem 调用此函数,参数为 {item, key, keyPath} | function | 无 |
| style | 根节点样式 | object | |
|----------|---------------|----------|--------------|
| theme | 主题颜色 | String: `light` `dark` | `light` |
| mode | 菜单类型,现在支持垂直、水平、和内嵌模式三种 | String: `vertical` `horizontal` `inline` | `vertical` |
| selectedKeys | 当前选中的菜单项 key 数组 | Array | |
| defaultSelectedKeys | 初始选中的菜单项 key 数组 | Array | |
| openKeys | 当前展开的 SubMenu 菜单项 key 数组 | Array | |
| defaultOpenKeys | 初始展开的 SubMenu 菜单项 key 数组 | | |
| onOpen | SubMenu 展开回调 | Function({ key, item, keyPath }) | |
| onClose | SubMenu 收起回调 | Function({ key, item, keyPath }) | |
| onSelect | 被选中时调 | Function({ item, key, selectedKeys }) | 无 |
| onDeselect | 取消选中时调用,仅在 multiple 生效 | Function({ item, key, selectedKeys }) | - |
| onClick | 点击 menuitem 调用此函数,参数为 {item, key, keyPath} | function | - |
| style | 根节点样式 | Object | |
> More options in [rc-menu](https://github.com/react-component/menu#api)
### Menu.Item props

Loading…
Cancel
Save