docs: update docs #71

pull/165/head
tjz 2018-07-17 21:27:06 +08:00
parent c65e1def1b
commit a4cc00b7a9
5 changed files with 15 additions and 15 deletions

View File

@ -7,14 +7,14 @@
| actions | The action list, shows at the bottom of the Card. | slot | - | | actions | The action list, shows at the bottom of the Card. | slot | - |
| bodyStyle | Inline style to apply to the card content | object | - | | bodyStyle | Inline style to apply to the card content | object | - |
| bordered | Toggles rendering of the border around the card | boolean | `true` | | bordered | Toggles rendering of the border around the card | boolean | `true` |
| cover | Card cover | ReactNode | - | | cover | Card cover | slot | - |
| extra | Content to render in the top-right corner of the card | string\|ReactNode | - | | extra | Content to render in the top-right corner of the card | string\|slot | - |
| hoverable | Lift up when hovering card | boolean | false | | hoverable | Lift up when hovering card | boolean | false |
| loading | Shows a loading indicator while the contents of the card are being fetched | boolean | false | | loading | Shows a loading indicator while the contents of the card are being fetched | boolean | false |
| tabList | List of TabPane's head. | Array<{key: string, tab: ReactNode}> | - | | tabList | List of TabPane's head. | Array<{key: string, tab: ReactNode}> | - |
| activeTabKey | Current TabPane's key | string | - | | activeTabKey | Current TabPane's key | string | - |
| defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - | | defaultActiveTabKey | Initial active TabPane's key, if `activeTabKey` is not set. | string | - |
| title | Card title | string\|ReactNode | - | | title | Card title | string\|slot | - |
| type | Card style type, can be set to `inner` or not set | string | - | | type | Card style type, can be set to `inner` or not set | string | - |
| onTabChange | Callback when tab is switched | (key) => void | - | | onTabChange | Callback when tab is switched | (key) => void | - |
@ -29,8 +29,8 @@
| Property | Description | Type | Default | | Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- | | -------- | ----------- | ---- | ------- |
| avatar | avatar or icon | ReactNode | - | | avatar | avatar or icon | slot | - |
| className | className of container | string | - | | className | className of container | string | - |
| description | description content | ReactNode | - | | description | description content | slot | - |
| style | style object of container | object | - | | style | style object of container | object | - |
| title | title content | ReactNode | - | | title | title content | slot | - |

View File

@ -8,14 +8,14 @@
| actions | 卡片操作组,位置在卡片底部 |slot | - | | actions | 卡片操作组,位置在卡片底部 |slot | - |
| bodyStyle | 内容区域自定义样式 | object | - | | bodyStyle | 内容区域自定义样式 | object | - |
| bordered | 是否有边框 | boolean | true | | bordered | 是否有边框 | boolean | true |
| cover | 卡片封面 | ReactNode | - | | cover | 卡片封面 | slot | - |
| extra | 卡片右上角的操作区域 | string\|slot | - | | extra | 卡片右上角的操作区域 | string\|slot | - |
| hoverable | 鼠标移过时可浮起 | boolean | false | | hoverable | 鼠标移过时可浮起 | boolean | false |
| loading | 当卡片内容还在加载中时,可以用 loading 展示一个占位 | boolean | false | | loading | 当卡片内容还在加载中时,可以用 loading 展示一个占位 | boolean | false |
| tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - | | tabList | 页签标题列表 | Array<{key: string, tab: ReactNode}> | - |
| activeTabKey | 当前激活页签的 key | string | - | | activeTabKey | 当前激活页签的 key | string | - |
| defaultActiveTabKey | 初始化选中页签的 key如果没有设置 activeTabKey | string | 第一个页签 | | defaultActiveTabKey | 初始化选中页签的 key如果没有设置 activeTabKey | string | 第一个页签 |
| title | 卡片标题 | string\|ReactNode | - | | title | 卡片标题 | string\|slot | - |
| type | 卡片类型,可设置为 `inner` 或 不设置 | string | - | | type | 卡片类型,可设置为 `inner` 或 不设置 | string | - |
| onTabChange | 页签切换的回调 | (key) => void | - | | onTabChange | 页签切换的回调 | (key) => void | - |
@ -30,8 +30,8 @@
| Property | Description | Type | Default | | Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- | | -------- | ----------- | ---- | ------- |
| avatar | 头像/图标 | ReactNode | - | | avatar | 头像/图标 | slot | - |
| className | 容器类名 | string | - | | className | 容器类名 | string | - |
| description | 描述内容 | ReactNode | - | | description | 描述内容 | slot | - |
| style | 定义容器类名的样式 | object | - | | style | 定义容器类名的样式 | object | - |
| title | 标题内容 | ReactNode | - | | title | 标题内容 | slot | - |

View File

@ -20,7 +20,7 @@ export default {
default: 'ant-input', default: 'ant-input',
type: String, type: String,
}, },
enterButton: PropTypes.oneOfType([PropTypes.bool, PropTypes.string, PropTypes.object]), enterButton: PropTypes.any,
}, },
model: { model: {
prop: 'value', prop: 'value',

View File

@ -12,7 +12,7 @@
| id | 输入框的 id | string | | | id | 输入框的 id | string | |
| prefix | 带有前缀图标的 input | string\|slot | | | prefix | 带有前缀图标的 input | string\|slot | |
| size | 控件大小。注:标准表单内的输入框大小限制为 `large`。可选 `large` `default` `small` | string | `default` | | size | 控件大小。注:标准表单内的输入框大小限制为 `large`。可选 `large` `default` `small` | string | `default` |
| suffix | 带有后缀图标的 input | string\|ReactNode | | | suffix | 带有后缀图标的 input | string\|slot | |
| type | 声明 input 类型,同原生 input 标签的 type 属性,见:[MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#属性)(请直接使用 `Input.TextArea` 代替 `type="textarea"`)。 | string | `text` | | type | 声明 input 类型,同原生 input 标签的 type 属性,见:[MDN](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input#属性)(请直接使用 `Input.TextArea` 代替 `type="textarea"`)。 | string | `text` |
| value(v-model) | 输入框内容 | string | | | value(v-model) | 输入框内容 | string | |
@ -43,7 +43,7 @@
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| enterButton | 是否有确认按钮,可设为按钮文字 | boolean\|ReactNode | false | | enterButton | 是否有确认按钮,可设为按钮文字 | boolean\|slot | false |
### Input.Search 事件 ### Input.Search 事件
| 事件名称 | 说明 | 回调参数 | | 事件名称 | 说明 | 回调参数 |

View File

@ -39,7 +39,7 @@ The sidebar.
| defaultCollapsed | to set the initial status | boolean | false | | defaultCollapsed | to set the initial status | boolean | false |
| reverseArrow | reverse direction of arrow, for a sider that expands from the right | boolean | false | | reverseArrow | reverse direction of arrow, for a sider that expands from the right | boolean | false |
| style | to customize the styles | object\|string | - | | style | to customize the styles | object\|string | - |
| trigger | specify the customized trigger, set to null to hide the trigger | string\|ReactNode | - | | trigger | specify the customized trigger, set to null to hide the trigger | string\|slot | - |
| width | width of the sidebar | number\|string | 200 | | width | width of the sidebar | number\|string | 200 |
### Events ### Events