CountDown 倒计时

介绍

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

代码演示

基础用法

time 属性表示倒计时总时长,单位为毫秒。

<z-count-down :time="time" />
import { ref } from 'vue';
const time = ref(30 * 60 * 60 * 1000)

自定义格式

通过 format 属性设置倒计时文本的内容。

<z-count-down :time="time" format="DD 天 HH 时 mm 分 ss 秒" />

毫秒级渲染

倒计时默认每秒渲染一次,设置 millisecond 属性可以开启毫秒级渲染。

<z-count-down millisecond :time="time" format="HH:mm:ss:SS" />

自定义样式

通过插槽自定义倒计时的样式,timeData 对象格式见下方表格。

<z-count-down :time="time">
  <template #default="{ current }">
    <text class="block">{{ current.hours }}</text>
    <text class="colon">:</text>
    <text class="block">{{ current.minutes }}</text>
    <text class="colon">:</text>
    <text class="block">{{ current.seconds }}</text>
  </template>
</z-count-down>

<style>
  .colon {
    display: inline-block;
    margin: 0 8rpx;
    color: var(--z-primary-color);
  }

  .block {
    display: inline-block;
    width: 44rpx;
    font-size: 24rpx;
    color: #fff;
    text-align: center;
    background-color: var(--z-primary-color);
    border-radius: 8rpx;
  }
</style>

手动控制

通过 ref 获取到组件实例后,可以调用 startpausereset 方法。

<view class="count-content">
  <z-count-down
    ref="countDown"
    millisecond
    :time="3000"
    :auto-start="false"
    format="ss:SSS"
    @finish="onFinish"
  />
</view>
<z-grid clickable :column-num="3">
  <z-grid-item icon="play-circle" text="开始" @click="start" />
  <z-grid-item icon="timeout" text="暂停" @click="pause" />
  <z-grid-item icon="reload" text="重置" @click="reset" />
</z-grid>
import { ref } from 'vue'
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const countDown = ref()
const start = () => {
  countDown.value?.start()
}
const pause = () => {
  countDown.value?.pause()
}
const reset = () => {
  countDown.value?.reset()
}
const onFinish = () => toast.showToast('倒计时结束')

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,重设后会自动开始倒计时--

主题定制

样式变量

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

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