CountDown 倒计时
引入
在app.json
或index.json
中引入组件,详细介绍见快速上手
"usingComponents": {
"van-count-down": "path/to/@vant/weapp/dist/count-down/index"
}
Vant Weapp 1.0 版本开始支持此组件,升级方式参见快速上手
代码演示
基本用法
time
属性表示倒计时总时长,单位为毫秒
<van-count-down time="{{ time }}" />
Page({
data: {
time: 30 * 60 * 60 * 1000
}
});
自定义格式
通过format
属性设置倒计时文本的内容
<van-count-down
time="{{ time }}"
format="DD 天 HH 时 mm 分 ss 秒"
/>
毫秒级渲染
倒计时默认每秒渲染一次,设置millisecond
属性可以开启毫秒级渲染
<van-count-down
millisecond
time="{{ time }}"
format="HH:mm:ss:SSS"
/>
自定义样式
设置use-slot
属性后可以自定义倒计时样式,需要通过bind:change
事件获取timeData
对象并自行渲染,格式见下方表格
<van-count-down
use-slot
time="{{ time }}"
bind:change="onChange"
>
<text class="item">{{ timeData.hours }}</text>
<text class="item">{{ timeData.minutes }}</text>
<text class="item">{{ timeData.seconds }}</text>
</van-count-down>
Page({
data: {
time: 30 * 60 * 60 * 1000,
timeData: {}
},
onChange(e) {
this.setData({
timeData: e.detail
});
}
});
.item {
display: inline-block;
width: 22px;
margin-right: 5px;
color: #fff;
font-size: 12px;
text-align: center;
background-color: #1989fa;
border-radius: 2px;
}
手动控制
通过 selectComponent
选择器获取到组件实例后,可以调用start
、pause
、reset
方法
<van-count-down
class="control-count-down"
millisecond
time="{{ 3000 }}"
auto-start="{{ false }}"
format="ss:SSS"
bind:finish="finished"
/>
<van-grid clickable column-num="3">
<van-grid-item text="开始" icon="play-circle-o" bindclick="start" />
<van-grid-item text="暂停" icon="pause-circle-o" bindclick="pause" />
<van-grid-item text="重置" icon="replay" bindclick="reset" />
</van-grid>
Page({
start() {
const countDown = this.selectComponent('.control-count-down');
countDown.start();
},
pause() {
const countDown = this.selectComponent('.control-count-down');
countDown.pause();
},
reset() {
const countDown = this.selectComponent('.control-count-down');
countDown.reset();
},
finished() {
Toast('倒计时结束');
}
});
API
Props
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
time | 倒计时时长,单位毫秒 | number | - | - |
format | 时间格式,DD-日,HH-时,mm-分,ss-秒,SSS-毫秒 | string | HH:mm:ss | - |
auto-start | 是否自动开始倒计时 | boolean | true | - |
millisecond | 是否开启毫秒级渲染 | boolean | false | - |
use-slot | 是否使用自定义样式插槽 | boolean | false | - |
Events
事件名 | 说明 | 回调参数 |
---|---|---|
finish | 倒计时结束时触发 | - |
change | 时间变化时触发,仅在开启use-slot 后才会触发 | timeData |
timeData 格式
名称 | 说明 | 类型 |
---|---|---|
days | 剩余天数 | number |
hours | 剩余小时 | number |
minutes | 剩余分钟 | number |
seconds | 剩余秒数 | number |
milliseconds | 剩余毫秒 | number |
方法
通过 selectComponent 可以获取到 CountDown 实例并调用实例方法
方法名 | 参数 | 返回值 | 介绍 |
---|---|---|---|
start | - | - | 开始倒计时 |
pause | - | - | 暂停倒计时 |
reset | - | - | 重设倒计时,若auto-start 为true ,重设后会自动开始倒计时 |