ant-design/components/menu/index.md

70 lines
2.7 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
chinese: 导航菜单
cols: 1
2016-05-11 14:21:01 +08:00
type: Navigation
2016-03-31 14:17:09 +08:00
english: Menu
---
2015-08-01 14:08:04 +08:00
2015-08-07 12:20:21 +08:00
为页面和功能提供导航的菜单列表。
2015-08-06 16:49:54 +08:00
## 何时使用
2015-08-07 12:20:21 +08:00
导航菜单是一个网站的灵魂,用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航,顶部导航提供全局性的类目和功能,侧边导航提供多级结构来收纳和排列网站架构。
2015-08-06 16:49:54 +08:00
2016-05-06 18:08:40 +08:00
更多布局和导航的范例可以参考:[常用布局](/docs/spec/layout)。
2015-11-17 16:33:47 +08:00
2015-08-06 16:49:54 +08:00
```html
<Menu>
<Menu.Item>菜单项</Menu.Item>
2015-08-06 16:49:54 +08:00
<SubMenu title="子菜单">
<Menu.Item>子菜单项</Menu.Item>
2015-08-06 16:49:54 +08:00
</SubMenu>
</Menu>
```
## API
### Menu props
| 参数 | 说明 | 类型 | 默认值 |
2016-05-08 16:05:07 +08:00
|----------|---------------|----------|--------------|
| 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)
2015-08-06 16:49:54 +08:00
### Menu.Item props
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
| disabled | 是否禁用 | Boolean | false |
2016-04-14 11:22:53 +08:00
| key | item 的唯一标志 | String | |
2015-08-06 16:49:54 +08:00
### Menu.SubMenu props
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
2016-05-07 16:03:51 +08:00
| disabled | 是否禁用 | Boolean | false |
| key | 唯一标志 | String | |
2015-08-06 16:49:54 +08:00
| title | 子菜单项值 | String or React.Element | |
2016-04-14 11:22:53 +08:00
| children | 子菜单的菜单项 | (MenuItem or SubMenu)[] | |
2016-05-07 16:03:51 +08:00
| onTitleClick | 点击子菜单标题 | Function({ eventKey, domEvent }) | |
2015-12-11 16:55:30 +08:00
### Menu.ItemGroup props
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
| title | 分组标题 | String or React.Element | |
2016-04-14 11:22:53 +08:00
| children | 分组的菜单项 | MenuItem[] | |