Skip to content

Commit

Permalink
fix: resolved some spelling mistake
Browse files Browse the repository at this point in the history
  • Loading branch information
@anlyyao
anlyyao committed Jul 12, 2023
1 parent 6f20716 commit 415097f
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 57 deletions.
2 changes: 1 addition & 1 deletion src/collapse/collapse.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@ Name | Default Value | Description
--td-collapse-content-text-color | @font-gray-1 | -
--td-collapse-extra-font-size | @font-size-m | -
--td-collapse-header-text-color | @font-gray-1 | -
--td-collapse-header-text-diabled-color | @font-gray-4 | -
--td-collapse-header-text-disabled-color | @font-gray-4 | -
--td-collapse-panel-bg-color | @bg-color-container | -
--td-collapse-title-font-size | @font-size-m | -
2 changes: 1 addition & 1 deletion src/collapse/collapse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ value | String / Number | - | 当前面板唯一标识，如果值为空则取
--td-collapse-content-text-color | @font-gray-1 | -
--td-collapse-extra-font-size | @font-size-m | -
--td-collapse-header-text-color | @font-gray-1 | -
--td-collapse-header-text-diabled-color | @font-gray-4 | -
--td-collapse-header-text-disabled-color | @font-gray-4 | -
--td-collapse-panel-bg-color | @bg-color-container | -
--td-collapse-title-font-size | @font-size-m | -
2 changes: 1 addition & 1 deletion src/steps/steps.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Name | Default Value | Description
--td-step-item-default-dot-border-color | @component-border | -
--td-step-item-default-icon-color | @font-gray-3 | -
--td-step-item-default-title-color | @font-gray-3 | -
--td-step-item-descrition-color | @font-gray-3 | -
--td-step-item-description-color | @font-gray-3 | -
--td-step-item-dot-size | 8px | -
--td-step-item-error-circle-bg | @error-color-1 | -
--td-step-item-error-circle-color | @error-color | -
Expand Down
96 changes: 48 additions & 48 deletions src/steps/steps.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,62 +3,62 @@
## API
### Steps Props

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
current | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。支持语法糖 `v-model` 或 `v-model:current` | N
defaultCurrent | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。非受控属性 | N
currentStatus | String | process | 用于控制 current 指向的步骤条的状态。可选项：default/process/finish/error | N
layout | String | horizontal | 步骤条方向，有两种：横向和纵向。可选项：horizontal/vertical | N
readonly | Boolean | false | 只读状态 | N
theme | String | default | 步骤条风格。可选项：default/dot | N
sequence | String | positive | 步骤条顺序。可选项：positive/reverse | N
onChange | Function | | TS 类型：`(current: string \| number, previous: string \| number, context?: { e?: MouseEvent }) => void`<br/>当前步骤发生变化时触发 | N
| 名称 | 类型 | 默认值 | 说明 | 必传 |
| -------------- | --------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
| current | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。支持语法糖 `v-model` 或 `v-model:current` | N |
| defaultCurrent | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。非受控属性 | N |
| currentStatus | String | process | 用于控制 current 指向的步骤条的状态。可选项：default/process/finish/error | N |
| layout | String | horizontal | 步骤条方向，有两种：横向和纵向。可选项：horizontal/vertical | N |
| readonly | Boolean | false | 只读状态 | N |
| theme | String | default | 步骤条风格。可选项：default/dot | N |
| sequence | String | positive | 步骤条顺序。可选项：positive/reverse | N |
| onChange | Function | | TS 类型：`(current: string \| number, previous: string \| number, context?: { e?: MouseEvent }) => void`<br/>当前步骤发生变化时触发 | N |

### Steps Events

名称 | 参数 | 描述
-- | -- | --
change | `(current: string \| number, previous: string \| number, context?: { e?: MouseEvent })` | 当前步骤发生变化时触发
| 名称 | 参数 | 描述 |
| ------ | --------------------------------------------------------------------------------------- | ---------------------- |
| change | `(current: string \| number, previous: string \| number, context?: { e?: MouseEvent })` | 当前步骤发生变化时触发 |

### StepItem Props

名称 | 类型 | 默认值 | 说明 | 必传
-- | -- | -- | -- | --
content | String / Slot / Function | '' | 步骤描述。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
icon | Boolean / Slot / Function | true | 图标，默认显示内置图标，也可以自定义图标，值为 false 则不显示图标。优先级大于 `status` 定义的图标。TS 类型：`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
status | String | default | 当前步骤的状态：默认状态（未开始）、进行中状态、完成状态、错误状态。可选项：default/process/finish/error。TS 类型：`StepStatus` `type StepStatus = 'default' \| 'process' \| 'finish' \| 'error'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/steps/type.ts) | N
title | String / Slot / Function | '' | 标题。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
titleRight | String / Slot / Function | '' | 标题右侧数据 仅支持 layout = 'vertical' 时。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N
| 名称 | 类型 | 默认值 | 说明 | 必传 |
| ---------- | ------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
| content | String / Slot / Function | '' | 步骤描述。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N |
| icon | Boolean / Slot / Function | true | 图标，默认显示内置图标，也可以自定义图标，值为 false 则不显示图标。优先级大于 `status` 定义的图标。TS 类型：`boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N |
| status | String | default | 当前步骤的状态：默认状态（未开始）、进行中状态、完成状态、错误状态。可选项：default/process/finish/error。TS 类型：`StepStatus` `type StepStatus = 'default' \| 'process' \| 'finish' \| 'error'`。[详细类型定义](https://github.com/Tencent/tdesign-mobile-vue/tree/develop/src/steps/type.ts) | N |
| title | String / Slot / Function | '' | 标题。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N |
| titleRight | String / Slot / Function | '' | 标题右侧数据 仅支持 layout = 'vertical' 时。TS 类型：`string \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-mobile-vue/blob/develop/src/common.ts) | N |



### CSS 变量
组件提供了下列 CSS 变量，可用于自定义样式。
名称 | 默认值 | 描述
-- | -- | --
--td-step-item-circle-font-size | 14px | -
--td-step-item-circle-size | 22px | -
--td-step-item-default-circle-bg | @bg-color-secondarycontainer | -
--td-step-item-default-circle-color | @font-gray-3 | -
--td-step-item-default-dot-border-color | @component-border | -
--td-step-item-default-icon-color | @font-gray-3 | -
--td-step-item-default-title-color | @font-gray-3 | -
--td-step-item-descrition-color | @font-gray-3 | -
--td-step-item-dot-size | 8px | -
--td-step-item-error-circle-bg | @error-color-1 | -
--td-step-item-error-circle-color | @error-color | -
--td-step-item-error-dot-border-color | @error-color | -
--td-step-item-error-icon-color | @error-color | -
--td-step-item-error-title-color | @error-color | -
--td-step-item-finish-circle-bg | @brand-color-light | -
--td-step-item-finish-circle-color | @brand-color | -
--td-step-item-finish-dot-border-color | @brand-color | -
--td-step-item-finish-icon-color | @brand-color | -
--td-step-item-finish-line-color | @brand-color | -
--td-step-item-finish-title-color | @font-gray-1 | -
--td-step-item-line-color | @component-border | -
--td-step-item-process-circle-bg | @brand-color | -
--td-step-item-process-circle-color | @font-white-1 | -
--td-step-item-process-dot-border-color | @brand-color | -
--td-step-item-process-icon-color | @brand-color | -
--td-step-item-process-title-color | @brand-color | -
| 名称 | 默认值 | 描述 |
| --------------------------------------- | ---------------------------- | ---- |
| --td-step-item-circle-font-size | 14px | - |
| --td-step-item-circle-size | 22px | - |
| --td-step-item-default-circle-bg | @bg-color-secondarycontainer | - |
| --td-step-item-default-circle-color | @font-gray-3 | - |
| --td-step-item-default-dot-border-color | @component-border | - |
| --td-step-item-default-icon-color | @font-gray-3 | - |
| --td-step-item-default-title-color | @font-gray-3 | - |
| --td-step-item-description-color | @font-gray-3 | - |
| --td-step-item-dot-size | 8px | - |
| --td-step-item-error-circle-bg | @error-color-1 | - |
| --td-step-item-error-circle-color | @error-color | - |
| --td-step-item-error-dot-border-color | @error-color | - |
| --td-step-item-error-icon-color | @error-color | - |
| --td-step-item-error-title-color | @error-color | - |
| --td-step-item-finish-circle-bg | @brand-color-light | - |
| --td-step-item-finish-circle-color | @brand-color | - |
| --td-step-item-finish-dot-border-color | @brand-color | - |
| --td-step-item-finish-icon-color | @brand-color | - |
| --td-step-item-finish-line-color | @brand-color | - |
| --td-step-item-finish-title-color | @font-gray-1 | - |
| --td-step-item-line-color | @component-border | - |
| --td-step-item-process-circle-bg | @brand-color | - |
| --td-step-item-process-circle-color | @font-white-1 | - |
| --td-step-item-process-dot-border-color | @brand-color | - |
| --td-step-item-process-icon-color | @brand-color | - |
| --td-step-item-process-title-color | @brand-color | - |
6 changes: 3 additions & 3 deletions src/switch/switch.en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ Name | Default Value | Description
--td-switch-unchecked-color | @font-gray-4 | -
--td-switch-unchecked-disabled-color | @bg-color-component-disabled | -
--td-switch-width | 45px | -
--td-swtich-label-font-size | 12px | -
--td-swtich-label-font-size | 14px | -
--td-swtich-label-font-size | 16px | -
--td-switch-label-font-size | 12px | -
--td-switch-label-font-size | 14px | -
--td-switch-label-font-size | 16px | -
6 changes: 3 additions & 3 deletions src/switch/switch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ change | `(value: T, context: { e: MouseEvent })` | 数据发生变化时触发
--td-switch-unchecked-color | @font-gray-4 | -
--td-switch-unchecked-disabled-color | @bg-color-component-disabled | -
--td-switch-width | 45px | -
--td-swtich-label-font-size | 12px | -
--td-swtich-label-font-size | 14px | -
--td-swtich-label-font-size | 16px | -
--td-switch-label-font-size | 12px | -
--td-switch-label-font-size | 14px | -
--td-switch-label-font-size | 16px | -

0 comments on commit 415097f

Please sign in to comment.