Skip to content

Commit 560759e

Browse files
committed
chore: 更新文档
1 parent e5af22f commit 560759e

File tree

6 files changed

+49
-29
lines changed

6 files changed

+49
-29
lines changed

src/packages/steps/doc.en-US.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ import { Steps } from '@nutui/nutui-react'
8888

8989
| Property | Description | Type | Default |
9090
| --- | --- | --- | --- |
91-
| direction | Display direction | `horizontal` \| `vertical` | `horizontal` |
91+
| direction | Display direction of the step bar | `horizontal` \| `vertical` | `horizontal` |
9292
| value | Current step | `number` | `0` |
93-
| status | Step bar status | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94-
| count | Number of steps | `2` \| `3` \| `4` | `-` |
95-
| type | Step type | `text` \| `dot` \| `icon` | `text` |
96-
| layout | Layout mode | `single` \| `double` | `single` |
93+
| status | Display status of the step bar | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94+
| type | Type of the step bar | `text` \| `dot` \| `icon` | `text` |
95+
| layout | Layout mode of the step bar | `single` \| `double` | `single` |
9796
| icon | Custom icon | `ReactNode` | `-` |
98-
| onStepClick | Triggered when clicking the title or icon of a step | `(index: number) => void` | `-` |
97+
| onStepClick | Triggered when switching steps | `(index: number) => void` | `-` |
9998

10099
## Step
101100

src/packages/steps/doc.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ import { Steps } from '@nutui/nutui-react'
8888

8989
| 属性 | 说明 | 类型 | 默认值 |
9090
| --- | --- | --- | --- |
91-
| direction | 显示方向 | `horizontal` \| `vertical` | `horizontal` |
91+
| direction | 步骤条的显示方向 | `horizontal` \| `vertical` | `horizontal` |
9292
| value | 当前所在的步骤 | `number` | `0` |
93-
| status | 步骤条状态 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94-
| count | 步骤数量 | `2` \| `3` \| `4` | `-` |
95-
| type | 步骤类型 | `text` \| `dot` \| `icon` | `text` |
96-
| layout | 布局方式 | `single` \| `double` | `single` |
93+
| status | 步骤条的展示状态 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94+
| type | 步骤条的类型 | `text` \| `dot` \| `icon` | `text` |
95+
| layout | 步骤条的布局方式 | `single` \| `double` | `single` |
9796
| icon | 自定义图标 | `ReactNode` | `-` |
98-
| onStepClick | 点击步骤的标题或图标时触发 | `(index: number) => void` | `-` |
97+
| onStepClick | 点击切换步骤条时触发 | `(index: number) => void` | `-` |
9998

10099
## Step
101100

@@ -107,7 +106,7 @@ import { Steps } from '@nutui/nutui-react'
107106
| description | 流程步骤的描述性文字 | `ReactNode` | `-` |
108107
| icon | 图标 | `ReactNode` | `-` |
109108
| value | 流程步骤的索引 | `number` | `0` |
110-
| type | 步骤类型 | `text` \| `dot` \| `icon` | `text` |
109+
| type | 当前步骤类型 | `text` \| `dot` \| `icon` | `text` |
111110

112111
## 主题定制
113112

src/packages/steps/doc.taro.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ import { Steps } from '@nutui/nutui-react-taro'
8888

8989
| 属性 | 说明 | 类型 | 默认值 |
9090
| --- | --- | --- | --- |
91-
| direction | 显示方向 | `horizontal` \| `vertical` | `horizontal` |
91+
| direction | 步骤条的显示方向 | `horizontal` \| `vertical` | `horizontal` |
9292
| value | 当前所在的步骤 | `number` | `0` |
93-
| status | 步骤条状态 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94-
| count | 步骤数量 | `2` \| `3` \| `4` | `-` |
95-
| type | 步骤类型 | `text` \| `dot` \| `icon` | `text` |
96-
| layout | 布局方式 | `single` \| `double` | `single` |
93+
| status | 步骤条的展示状态 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94+
| type | 步骤条的类型 | `text` \| `dot` \| `icon` | `text` |
95+
| layout | 步骤条的布局方式 | `single` \| `double` | `single` |
9796
| icon | 自定义图标 | `ReactNode` | `-` |
98-
| onStepClick | 点击步骤的标题或图标时触发 | `(index: number) => void` | `-` |
97+
| onStepClick | 点击切换步骤条时触发 | `(index: number) => void` | `-` |
9998

10099
## Step
101100

src/packages/steps/doc.zh-TW.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,14 +88,13 @@ import { Steps } from '@nutui/nutui-react'
8888

8989
| 屬性 | 說明 | 類型 | 默認值 |
9090
| --- | --- | --- | --- |
91-
| direction | 顯示方嚮 | `horizontal` \| `vertical` | `horizontal` |
91+
| direction | 步驟條的顯示方嚮 | `horizontal` \| `vertical` | `horizontal` |
9292
| value | 當前所在的步驟 | `number` | `0` |
93-
| status | 步驟條狀態 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94-
| count | 步驟數量 | `2` \| `3` \| `4` | `-` |
95-
| type | 步驟類型 | `text` \| `dot` \| `icon` | `text` |
96-
| layout | 布局方式 | `single` \| `double` | `single` |
93+
| status | 步驟條的展示狀態 | `default` \| `business` \| `dynamic` \| `enhanced` | `default` |
94+
| type | 步驟條的類型 | `text` \| `dot` \| `icon` | `text` |
95+
| layout | 步驟條的布局方式 | `single` \| `double` | `single` |
9796
| icon | 自定義圖標 | `ReactNode` | `-` |
98-
| onStepClick | 點擊步驟的標題或圖標時觸發 | `(index: number) => void` | `-` |
97+
| onStepClick | 點擊切換步驟條時觸發 | `(index: number) => void` | `-` |
9998

10099
## Step
101100

src/sites/sites-react/doc/docs/react/migrate-from-v2.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,8 +309,20 @@ plugins: [
309309
- 新增 `duration` 属性,控制动画时长
310310
- 新增 `size` 属性,通过 `size` 属性可选择使用组件内置的高度
311311

312-
[//]: # '#### Steps'
313-
[//]: # '#### Step'
312+
#### Steps
313+
314+
- 新增 `status` 属性,设置步骤条的展示状态
315+
- 新增 `layout` 属性,设置步骤条的布局方式
316+
- 新增 `type` 属性,设置步骤条的类型
317+
- 新增 `icon` 属性,设置自定义图标
318+
- 移除 `dot` 属性,可使用 `type` 属性
319+
- 新增 `onStepClick`, 点击切换步骤条时触发
320+
321+
#### Step
322+
323+
- 修改 `title``description` 的类型为 `ReactNode`
324+
- 新增 `type` 属性,设置步骤条类型
325+
314326
[//]: # '#### Swiper'
315327
[//]: # '#### Table'
316328
[//]: # '#### Tag'

src/sites/sites-react/doc/docs/taro/migrate-from-v2.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,8 +308,20 @@ plugins: [
308308
- 新增 `duration` 属性,控制动画时长
309309
- 新增 `size` 属性,通过 `size` 属性可选择使用组件内置的高度
310310

311-
[//]: # '#### Steps'
312-
[//]: # '#### Step'
311+
#### Steps
312+
313+
- 新增 `status` 属性,设置步骤条的展示状态
314+
- 新增 `layout` 属性,设置步骤条的布局方式
315+
- 新增 `type` 属性,设置步骤条的类型
316+
- 新增 `icon` 属性,设置自定义图标
317+
- 移除 `dot` 属性,可使用 `type` 属性
318+
- 新增 `onStepClick`, 点击切换步骤条时触发
319+
320+
#### Step
321+
322+
- 修改 `title``description` 的类型为 `ReactNode`
323+
- 新增 `type` 属性,设置步骤条类型
324+
313325
[//]: # '#### Swiper'
314326
[//]: # '#### Table'
315327
[//]: # '#### Tag'

0 commit comments

Comments
 (0)