Improve doc

This commit is contained in:
afc163 2017-06-16 16:56:03 +08:00
parent 88ee7b3e8e
commit 9969a3b598
4 changed files with 12 additions and 12 deletions

View File

@ -29,7 +29,7 @@ When need to mention someone or something.
| getMentions | get mentioned people in current contentState | Function(ContentState: contentState): string[] |
### Mention props
### Mention
| Property | Description | Type | Default |
|----------|---------------|----------|--------------|
@ -51,7 +51,7 @@ When need to mention someone or something.
| readOnly | Tell if the input is readonly. | boolean | false |
| disabled | Tell if the input is disabled. | boolean | false |
### Nav props
### Nav
| Property | Description | Type | Default |
|----------|---------------|----------|--------------|

View File

@ -29,7 +29,7 @@ title: Mention
| toEditorState(兼容) | 把字符串转成 ContentState | Function(value: string): ContentState |
| getMentions | 获取当前 contentState 中提到的人的列表 | Function(contentState: ContentState): string[] |
### Mention props
### Mention
| 参数 | 说明 | 类型 | 默认值 |
|----------|---------------|----------|--------------|
@ -51,7 +51,7 @@ title: Mention
| readOnly | 是否只读. | boolean | false |
| disabled | 是否禁用状态. | boolean | false |
### Nav props
### Nav
| 参数 | 说明 | 类型 | 默认值 |
|----------|---------------|----------|--------------|

View File

@ -24,7 +24,7 @@ More layout and samples: [layout](/docs/spec/layout).
## API
### Menu props
### Menu
| Param | Description | Type | Default value |
|----------|---------------|----------|--------------|
@ -45,14 +45,14 @@ More layout and samples: [layout](/docs/spec/layout).
> More options in [rc-menu](https://github.com/react-component/menu#api)
### Menu.Item props
### Menu.Item
| Param | Description | Type | Default value |
|----------|----------------|----------|--------------|
| disabled | disabled or not | boolean | false |
| key | unique id of the menu item | string | |
### Menu.SubMenu props
### Menu.SubMenu
| Param | Description | Type | Default value |
|----------|----------------|----------|--------------|
@ -62,7 +62,7 @@ More layout and samples: [layout](/docs/spec/layout).
| children | sub menus or sub menu items | Array<MenuItem\|SubMenu> | |
| onTitleClick | callback of the clicked sub menu title | Function({ key, domEvent }) | |
### Menu.ItemGroup props
### Menu.ItemGroup
| Param | Description | Type | Default value |
|----------|----------------|----------|--------------|

View File

@ -25,7 +25,7 @@ subtitle: 导航菜单
## API
### Menu props
### Menu
| 参数 | 说明 | 类型 | 默认值 |
|----------|---------------|----------|--------------|
@ -45,14 +45,14 @@ subtitle: 导航菜单
> More options in [rc-menu](https://github.com/react-component/menu#api)
### Menu.Item props
### Menu.Item
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
| disabled | 是否禁用 | boolean | false |
| key | item 的唯一标志 | string | |
### Menu.SubMenu props
### Menu.SubMenu
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|
@ -62,7 +62,7 @@ subtitle: 导航菜单
| children | 子菜单的菜单项 | Array<MenuItem\|SubMenu> | |
| onTitleClick | 点击子菜单标题 | Function({ key, domEvent }) | |
### Menu.ItemGroup props
### Menu.ItemGroup
| 参数 | 说明 | 类型 | 默认值 |
|----------|----------------|----------|--------------|