Skip to content

CountDown 倒计时

用于实时展示倒计时数值,支持毫秒精度。

基础用法

自定义格式

毫秒级渲染

自定义样式

手动控制

API

Props

参数说明类型默认值
time倒计时时长,单位毫秒number | string0
format时间格式stringHH:mm:ss
auto-start是否自动开始倒计时booleantrue
millisecond是否开启毫秒级渲染booleanfalse

format 格式

格式说明
DD天数
HH小时
mm分钟
ss秒数
S毫秒(1 位)
SS毫秒(2 位)
SSS毫秒(3 位)

Events

事件名说明回调参数
finish倒计时结束时触发-
change倒计时变化时触发currentTime: CurrentTime

Slots

名称说明参数
default自定义内容currentTime: CurrentTime

CurrentTime 格式

名称说明类型
total剩余总时间(单位毫秒)number
days剩余天数number
hours剩余小时number
minutes剩余分钟number
seconds剩余秒数number
milliseconds剩余毫秒number

方法

通过 ref 可以获取到 CountDown 实例并调用实例方法,详见组件实例方法

方法名说明参数返回值
start开始倒计时--
pause暂停倒计时--
reset重设倒计时,若 auto-starttrue,重设后会自动开始倒计时--

类型定义

组件导出以下类型定义:

ts
import type {
  CountDownProps,
  CountDownInstance,
  CountDownCurrentTime
} from 'ryxon'

CountDownInstance 是组件实例的类型,用法如下:

ts
import { ref } from 'vue'
import type { CountDownInstance } from 'ryxon'

const countDownRef = ref<CountDownInstance>()

countDownRef.value?.start()

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-count-down-text-colorvar(--r-text-color)-
--r-count-down-font-sizevar(--r-font-size-md)-
--r-count-down-line-heightvar(--r-line-height-md)-

常见问题

在 iOS 系统上倒计时不生效?

如果你遇到了在 iOS 上倒计时不生效的问题,请确认在创建 Date 对象时没有使用new Date('2020-01-01')这样的写法,iOS 不支持以中划线分隔的日期格式,正确写法是new Date('2020/01/01')

对此问题的详细解释:stackoverflow

Released under the MIT License.