From 55a37ad86d42d2eea8c9e21271fd82dfd34ec268 Mon Sep 17 00:00:00 2001
From: MrXiangXvFan <74048960+MrXiangXvFan@users.noreply.github.com>
Date: Tue, 8 Oct 2024 13:39:44 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20countDown=E6=96=87=E6=A1=A3=E8=A1=A5?=
 =?UTF-8?q?=E5=85=A8=20(#707)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 packages/vantui/types/count-down.d.ts | 48 +++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/packages/vantui/types/count-down.d.ts b/packages/vantui/types/count-down.d.ts
index 298050c34..1453f7fca 100644
--- a/packages/vantui/types/count-down.d.ts
+++ b/packages/vantui/types/count-down.d.ts
@@ -3,27 +3,75 @@ import { ReactNode } from 'react'
 import { ViewProps } from '@tarojs/components'
 
 export interface ICountDownRef {
+  /**
+   * @description 开始倒计时
+   */
   start: () => void
+  /**
+   * @description 暂停倒计时
+   */
   pause: () => void
+  /**
+   * @description 重设倒计时，若autoStart为true，重设后会自动开始倒计时
+   */
   reset: () => void
 }
 
 export interface ITimeData {
+  /**
+   * @description 剩余天数
+   */
   days: number
+  /**
+   * @description 剩余小时
+   */
   hours: number
+  /**
+   * @description 剩余分钟
+   */
   minutes: number
+  /**
+   * @description 剩余秒数
+   */
   seconds: number
+  /**
+   * @description 	剩余毫秒
+   */
   milliseconds: number
 }
 
 export interface CountDownProps extends ViewProps {
+  /**
+   * @description 是否开启毫秒级渲染
+   * @default false
+   */
   millisecond?: boolean
+  /**
+   * @description 倒计时时长，单位毫秒
+   */
   time?: number
+  /**
+   * @description 时间格式，DD-日，HH-时，mm-分，ss-秒，SSS-毫秒
+   * @default HH：mm：ss
+   */
   format?: string
+  /**
+   * @description 是否自动开始倒计时
+   * @default true
+   */
   autoStart?: boolean
+  /**
+   * @description 倒计时的内容
+   */
   children?: ReactNode
   onChange?: (timeData: { detail: ITimeData }) => void
+  /**
+   * @description 倒计时结束时触发
+   */
   onFinish?: () => void
+  /**
+   * @description 倒计时实例
+   */
   ref?: React.MutableRefObject<ICountDownRef | undefined>
 }