CountDown 倒计时

该组件一般使用于某个活动的截止时间上,通过数字的变化,给用户明确的时间感受,提示用户进行某一个行为操作。

平台差异说明

AppH5微信小程序支付宝小程序百度小程序头条小程序QQ小程序

基本使用

  • 通过timestamp参数设置倒计时间,单位为
  1. <template>
  2. <u-count-down :timestamp="timestamp"></u-count-down>
  3. </template>
  4. <script>
  5. export default {
  6. data() {
  7. timestamp: 86400,
  8. }
  9. }
  10. </script>

设置是否显示天,时,分,秒

说明:参数的配置原则应该是”自右向左”的,设置了”时”,它右边的”分”和”秒”也应该设置为true

  • show-daysshow-hoursshow-minutesshow-seconds等参数默认为true,分别对应是否显示倒计时的”天”,”时”,”分”,”秒”。

该示例表示只显示倒计时的分和秒

  1. <u-count-down :timestamp="86400" :show-days="false" :show-hours="false"></u-count-down>

倒计时分隔符

通过配置separator参数为colon或者zh来区分分隔符。separator-size配置分隔符的大小,单位rpx。separator-color配置分隔符的颜色 separator可选值如下:

  • colon(默认)时显示为冒号,如:23:14:51
  • zh时显示为中文,如:23时14分51秒
  1. <u-count-down :timestamp="86400" separator="colon" separator-size="28" separator-color="#606266"></u-count-down>

倒计时样式

  • 通过color设置倒计数字的颜色
  • font-size设置倒计数字的大小,重申一次:uView中,所有font-sizewidthheightpaddingmargin等props参数 的单位默认都是rpx,特别说明除外(极少数场景会要求px单位)。关于rpx单位的说明,请参考uni官方文档:尺寸单位CountDown 倒计时 - 图1
  • show-border参数设置倒计数字是否添加边框,border-color参数设置边框的颜色
  1. <u-count-down :timestamp="86400" :show-border="true" font-size="28" color="#606266" border-color="#909399"></u-count-down>

倒计时执行的时机

通过autoplay配置倒计时是否在组件的mounted生命周期进行初始化(在timestamp有值前提下),如果设置autoplayfalse,就需要手动通过 refs的形式通知倒计时开始执行,调用的是组件内部的start()方法

  1. <template>
  2. <u-count-down ref="uCountDown" :timestamp="86400" :autoplay="false"></u-count-down>
  3. </template>
  4. <script>
  5. export default {
  6. onLoad() {
  7. setTimeout(() => {
  8. this.$refs.uCountDown.start();
  9. }, 2000)
  10. }
  11. }
  12. </script>

如何获取当前倒计的秒数

有时候我们可会需要记录当前剩余的秒数,并在某个时机重新触发,可以通过如下两个方式实现:

  • 监听change事件,在回调中获得当前剩余的秒数
  • 通过ref调用,获取内部的seconds参数即为当前剩余的秒数
  1. <template>
  2. <u-count-down ref="uCountDown" :timestamp="timestamp" @change="change"></u-count-down>
  3. </template>
  4. <script>
  5. export default {
  6. data() {
  7. return {
  8. timestamp: 86400
  9. }
  10. },
  11. methods: {
  12. // 事件触发,每秒一次
  13. change(timestamp) {
  14. console.log(timestamp);
  15. },
  16. // ref形式获取内部的值
  17. getSeconds() {
  18. console.log(this.$refs.uCountDown.seconds);
  19. }
  20. }
  21. }
  22. </script>

API

Props

参数说明类型默认值可选值
timestamp倒计时,单位为秒String | Number0-
autoplay是否自动开始倒计时,如果为false,需手动调用开始方法。见上方说明Booleantruefalse
separator分隔符,colon为英文冒号,zh为中文Stringcolonzh
separator-size分隔符的字体大小,单位rpxString | Number30-
separator-color分隔符的颜色String#303133-
font-size倒计时字体大小,单位rpxString | Number30-
show-border是否显示倒计时数字的边框Booleanfalsetrue
border-color数字边框的颜色String#303133-
bg-color倒计时数字的背景颜色String#ffffff-
color倒计时数字的颜色String#303133-
height数字高度值(宽度等同此值),设置边框时看情况是否需要设置此值,单位rpxStringauto-
show-days是否显示倒计时的”天”部分Booleantruefalse
show-hours是否显示倒计时的”时”部分Booleantruefalse
show-minutes是否显示倒计时的”分”部分Booleantruefalse
show-seconds是否显示倒计时的”秒”部分Booleantruefalse

Events

事件名说明回调参数
end倒计时结束-
change倒计过程中,每秒触发一次timestamp: 当前剩余的倒计秒数

Methods

需要通过ref获取倒计时组件才能调用,见上方”倒计时执行的时机”说明

名称说明
start开始倒计时