1.1.0 • Published 5 years ago

countdown-ti v1.1.0

Weekly downloads
2
License
MIT
Repository
-
Last release
5 years ago

countdown-ti

基于时间戳的倒计时插件

使用

通过 npm 安装

$ yarn add countdown-ti
# 或者
$ npm i -S countdown-ti
import countdown from 'countdown-ti';
// const countdown = require('countdown-ti');

countdown(3, (sec) => {
  console.log('tick', sec);
}, () => {
  console.log('complete');
});

或者直接在 html 中引入。

<script src="dist/countdown.js"></script>
<script>
countdown(3, function (sec) {
  console.log('tick', sec);
}, function () {
  console.log('complete');
});
</script>

使用例子:

// 2参数 倒计时秒数,结束回调
countdown(10, () => {
  console.log('done');
});

// 3参数 倒计时秒数,倒计时回调,结束回调
countdown(10, (sec) => {
  console.log(sec); // 显示剩余秒数
}, () => {
  console.log('done');
});

// 2参数 10位时间戳,结束回调
countdown(1513826388, () => {
  console.log('done');
});

// 2参数 13位时间戳,结束回调
countdown(1513826388000, () => {
  console.log('done');
});

// 2参数 日期格式字符串,结束回调
countdown('2017-11-11 11:11:11', () => {
  // 要兼容id6/safari,请将时间改成 '2017/11/11 11:11:11'
  console.log('done');
});

API

countdown(seconds, onTick?, onComplete)

seconds

Type: number string

倒计时时间:

  • 可以是剩余秒数,如 3
  • 可以是结束时间戳,如 1513844655238 或 1513844655 (支持13位和10位时间戳)
  • 可以是日期格式的字符串,如 '2017-12-21 16:24:54' 或 'Thu, 21 Dec 2017 08:25:15 GMT'
onTick

Type: callback

倒计时回调,参数可以得到当前剩余秒数。

onComplete

Type: callback

倒计时完成回调,没有参数。