/*! For license information please see 9456.5caef5ad.js.LICENSE.txt */ (self.webpackChunk=self.webpackChunk||[]).push([["9456"],{52238:function(s,n,a){"use strict";a.r(n);var t=a("80681");let l=["innerHTML"];n.default={setup:()=>({html:""}),render:()=>((0,t.wg)(),(0,t.iD)("div",{class:"van-doc-markdown-body",innerHTML:'

useCountDown

\n

Intro

\n

Used to manage the countdown.

\n

Usage

\n

Basic Usage

\n
<span>Total time\uFF1A{{ current.total }}</span>\n<span>Remain days\uFF1A{{ current.days }}</span>\n<span>Remain hours\uFF1A{{ current.hours }}</span>\n<span>Remain minutes\uFF1A{{ current.minutes }}</span>\n<span>Remain seconds\uFF1A{{ current.seconds }}</span>\n<span>Remain milliseconds\uFF1A{{ current.milliseconds }}</span>\n
\n
import { useCountDown } from '@vant/use';\n\nexport default {\n  setup() {\n    const countDown = useCountDown({\n      time: 24 * 60 * 60 * 1000,\n    });\n\n    countDown.start();\n\n    return {\n      current: countDown.current,\n    };\n  },\n};\n
\n

Millisecond

\n
import { useCountDown } from '@vant/use';\n\nexport default {\n  setup() {\n    const countDown = useCountDown({\n      time: 24 * 60 * 60 * 1000,\n      millisecond: true,\n    });\n    countDown.start();\n\n    return {\n      current: countDown.current,\n    };\n  },\n};\n
\n

API

\n

Type Declarations

\n
type CurrentTime = {\n  days: number;\n  hours: number;\n  total: number;\n  minutes: number;\n  seconds: number;\n  milliseconds: number;\n};\n\ntype CountDown = {\n  start: () => void;\n  pause: () => void;\n  reset: (totalTime: number) => void;\n  current: ComputedRef<CurrentTime>;\n};\n\ntype UseCountDownOptions = {\n  time: number;\n  millisecond?: boolean;\n  onChange?: (current: CurrentTime) => void;\n  onFinish?: () => void;\n};\n\nfunction useCountDown(options: UseCountDownOptions): CountDown;\n
\n

Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescriptionTypeDefault Value
timeTotal time, unit millisecondsnumber-
millisecondWhether to enable millisecond renderbooleanfalse
onChangeTriggered when count down changed(current: CurrentTime) => void-
onFinishTriggered when count down finished() => void-
\n

Return Value

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescriptionType
currentCurrent remain timeCurrentTime
startStart count down() => void
pausePause count down() => void
resetReset count down(time?: number): void
\n

CurrentTime Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescriptionType
totalTotal time, unit millisecondsnumber
daysRemain daysnumber
hoursRemain hoursnumber
minutesRemain minutesnumber
secondsRemain secondsnumber
millisecondsRemain millisecondsnumber
\n
'},null,8,l))}}}]);