update steps doc

This commit is contained in:
afc163 2016-04-06 16:16:36 +08:00
parent af04694776
commit 60ebf2922c

View File

@ -27,20 +27,20 @@
整体步骤条。
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|-----------|------------------------------------------|------------|-------|--------|
| current | 可选参数,指定当前处理正在执行状态的步骤从0开始记数。在子Step元素中可以通过status属性覆盖状态 | number | 无 | 0 |
| size | 可选参数,指定大小(目前只支持普通和迷你两种大小)。 | string | small, default | default |
| direction | 可选参数,指定步骤条方向(目前支持水平和竖直两种方向,默认水平方向)。 | string | vertical | 无 |
| maxDescriptionWidth | 可选参数,指定步骤的详细描述文字的最大宽度。 | number | 无 | 100 |
| 参数 | 说明 | 类型 | 默认值 |
|-----------|------------------------------------------|-------------|-------|
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 `status` 属性覆盖状态 | number | 0 |
| size | 指定大小,目前支持普通(`default`)和迷你(`small`| string | default |
| direction | 指定步骤条方向。目前支持水平和竖直(`vertical`)两种方向,默认水平方向) | string | - |
| maxDescriptionWidth | 指定步骤的详细描述文字的最大宽度(单位 px | number | 100 |
### Steps.Step
步骤条内的每一个步。
步骤条内的每一个步
| 参数 | 说明 | 类型 | 可选值 |默认值 |
|-----------|------------------------------------------|------------|-------|--------|
| status | 可选参数,指定状态。当不配置该属性时,会使用父Steps元素的current来自动指定状态。 | string | wait, process, finish | wait |
| title | 必要参数,标题。 | string/jsx | 无 | 无 |
| description | 可选参数,步骤的详情描述。 | string/jsx | 无 | 空 |
| icon | 可选参数步骤的Icon。如果不指定则使用默认的样式。 | string/jsx | 无 | 空 |
| 参数 | 说明 | 类型 | 默认值 |
|----------|-----------------------------------------|------------|-------|
| status | 指定状态。当不配置该属性时,会使用 Steps 的 `current` 来自动指定状态。可选:`wait` `process` `finish` | string | `wait` |
| title | 标题 | React.Element | - |
| description | 步骤的详情描述,可选 | React.Element | - |
| icon | 步骤图标,可选 | React.Element | - |