From aeeb7339c6ecece80153c5bd538fd64a1e1ddda9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=8E=E4=BC=9F=E6=9D=B0?= <674416404@qq.com> Date: Tue, 23 Jul 2024 13:23:09 +0800 Subject: [PATCH] docs: sync api --- src/progress/progress.en-US.md | 4 ++-- src/progress/progress.md | 7 ++++--- src/progress/props.ts | 7 ++++--- src/progress/type.ts | 9 ++++----- 4 files changed, 14 insertions(+), 13 deletions(-) diff --git a/src/progress/progress.en-US.md b/src/progress/progress.en-US.md index 8f90127a7c..1bfc1482f0 100644 --- a/src/progress/progress.en-US.md +++ b/src/progress/progress.en-US.md @@ -10,7 +10,7 @@ color | String / Object / Array | '' | Typescript：`string \| Array \| label | String / Boolean / Slot / Function | true | Typescript：`string \| boolean \| TNode`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N percentage | Number | 0 | \- | N size | String / Number | 'medium' | \- | N -status | String | - | options：success/error/warning/active。Typescript：`StatusEnum` `type StatusEnum = 'success' \| 'error' \| 'warning' \| 'active'`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N +status | String | - | options: success/error/warning/active。Typescript：`ProgressStatus` `type ProgressStatus = 'success' \| 'error' \| 'warning' \| 'active'`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N strokeWidth | String / Number | - | \- | N -theme | String | line | options：line/plump/circle。Typescript：`ThemeEnum` `type ThemeEnum = 'line' \| 'plump' \| 'circle'`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N +theme | String | line | options: line/plump/circle。Typescript：`ProgressTheme` `type ProgressTheme = 'line' \| 'plump' \| 'circle'`。[see more ts definition](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N trackColor | String | '' | \- | N diff --git a/src/progress/progress.md b/src/progress/progress.md index 0af7a83e03..d883485284 100644 --- a/src/progress/progress.md +++ b/src/progress/progress.md @@ -1,15 +1,16 @@ :: BASE_DOC :: ## API + ### Progress Props -名称 | 类型 | 默认值 | 说明 | 必传 +名称 | 类型 | 默认值 | 描述 | 必传 -- | -- | -- | -- | -- color | String / Object / Array | '' | 进度条颜色。示例：'#ED7B2F' 或 'orange' 或 `['#f00', '#0ff', '#f0f']` 或 `{ '0%': '#f00', '100%': '#0ff' }` 或 `{ from: '#000', to: '#000' }` 等。TS 类型：`string \| Array \| Record` | N label | String / Boolean / Slot / Function | true | 进度百分比，可自定义。TS 类型：`string \| boolean \| TNode`。[通用类型定义](https://github.com/Tencent/tdesign-vue-next/blob/develop/src/common.ts) | N percentage | Number | 0 | 进度条百分比 | N size | String / Number | 'medium' | 进度条尺寸，示例：small/medium/large/240。small 值为 72； medium 值为 112；large 值为 160 | N -status | String | - | 进度条状态。可选项：success/error/warning/active。TS 类型：`StatusEnum` `type StatusEnum = 'success' \| 'error' \| 'warning' \| 'active'`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N +status | String | - | 进度条状态。可选项：success/error/warning/active。TS 类型：`ProgressStatus` `type ProgressStatus = 'success' \| 'error' \| 'warning' \| 'active'`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N strokeWidth | String / Number | - | 进度条线宽。宽度数值不能超过 size 的一半，否则不能输出环形进度 | N -theme | String | line | 进度条风格。值为 line，标签（label）显示在进度条右侧；值为 plump，标签（label）显示在进度条里面；值为 circle，标签（label）显示在进度条正中间。可选项：line/plump/circle。TS 类型：`ThemeEnum` `type ThemeEnum = 'line' \| 'plump' \| 'circle'`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N +theme | String | line | 进度条风格。值为 line，标签（label）显示在进度条右侧；值为 plump，标签（label）显示在进度条里面；值为 circle，标签（label）显示在进度条正中间。可选项：line/plump/circle。TS 类型：`ProgressTheme` `type ProgressTheme = 'line' \| 'plump' \| 'circle'`。[详细类型定义](https://github.com/Tencent/tdesign-vue-next/tree/develop/src/progress/type.ts) | N trackColor | String | '' | 进度条未完成部分颜色 | N diff --git a/src/progress/props.ts b/src/progress/props.ts index 1bdb96b612..a453bcfcf2 100644 --- a/src/progress/props.ts +++ b/src/progress/props.ts @@ -2,7 +2,6 @@ /** * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC - * updated at 2021-12-12 19:17:30 * */ import { TdProgressProps } from './type'; @@ -17,7 +16,7 @@ export default { /** 进度百分比，可自定义 */ label: { type: [String, Boolean, Function] as PropType, - default: true, + default: true as TdProgressProps['label'], }, /** 进度条百分比 */ percentage: { @@ -27,12 +26,13 @@ export default { /** 进度条尺寸，示例：small/medium/large/240。small 值为 72； medium 值为 112；large 值为 160 */ size: { type: [String, Number] as PropType, - default: 'medium', + default: 'medium' as TdProgressProps['size'], }, /** 进度条状态 */ status: { type: String as PropType, validator(val: TdProgressProps['status']): boolean { + if (!val) return true; return ['success', 'error', 'warning', 'active'].includes(val); }, }, @@ -45,6 +45,7 @@ export default { type: String as PropType, default: 'line' as TdProgressProps['theme'], validator(val: TdProgressProps['theme']): boolean { + if (!val) return true; return ['line', 'plump', 'circle'].includes(val); }, }, diff --git a/src/progress/type.ts b/src/progress/type.ts index f824e3169e..984b9c045f 100644 --- a/src/progress/type.ts +++ b/src/progress/type.ts @@ -2,7 +2,6 @@ /** * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC - * updated at 2021-12-12 19:17:30 * */ import { TNode } from '../common'; @@ -31,7 +30,7 @@ export interface TdProgressProps { /** * 进度条状态 */ - status?: StatusEnum; + status?: ProgressStatus; /** * 进度条线宽。宽度数值不能超过 size 的一半，否则不能输出环形进度 */ @@ -40,7 +39,7 @@ export interface TdProgressProps { * 进度条风格。值为 line，标签（label）显示在进度条右侧；值为 plump，标签（label）显示在进度条里面；值为 circle，标签（label）显示在进度条正中间 * @default line */ - theme?: ThemeEnum; + theme?: ProgressTheme; /** * 进度条未完成部分颜色 * @default '' @@ -48,6 +47,6 @@ export interface TdProgressProps { trackColor?: string; } -export type StatusEnum = 'success' | 'error' | 'warning' | 'active'; +export type ProgressStatus = 'success' | 'error' | 'warning' | 'active'; -export type ThemeEnum = 'line' | 'plump' | 'circle'; +export type ProgressTheme = 'line' | 'plump' | 'circle';