2.1.0 • Published 5 years ago

countdown-plugin v2.1.0

Weekly downloads
2
License
ISC
Repository
github
Last release
5 years ago

countdown

countdown 一个轻量级倒计时插件,不依赖任何框架。

countdown演示:demo

如何使用

  • 首先,引入 countdown.min.js(该文件包含在demo目录)
<script src="countdown.min.js"></script>

或者,你也可以使用模块的形式引入到代码中,只需要先安装它:

npm install countdown-plugin

再引入模块:

// 普通引入
var Countdown = require('countdown-plugin');

// es6引入
import Countdown from 'countdown-plugin'
  • 然后,在页面里实例化它:
var c1 = new Countdown();
  • 最后,通过 start 方法启动定时器:
c1.start();

当需要暂停定时器时,可通过 stop 方法:

c1.stop();

参数

当用户需要自定义倒计时,可以给实例化的 Countdown 方法传递相关参数。这些参数包括一些内容:

参数描述默认值格式
begin开始时间new Date(),即当前时间String 或 Date object
end结束时间'2030/01/01'String
timestamp时间戳,常用于设置倒计时的时间,单位为。当设置此项时,begin 和 end 会被忽略0String 或 Number
isFormat是否格式化输出的时间格式,比如 年-yyyy, 天-ddfalse,即不格式Boolean
isMilliSecond是否输出毫秒false,即不输出Boolean
change时间每次更新后的回调函数。它包含一个参数,该参数是一个包含了年、天、时、分、秒、毫秒这些属性的对象function(res) {console.log(res);}Function
over倒计时结束后的回调函数。function() {console.log('The countdown is over');}Function

方法

countdown 提供了两个实例方法:

参数描述默认值格式
start启动倒计时Function
stop暂停倒计时Function
2.1.0

5 years ago

2.0.0

5 years ago

0.0.5

6 years ago

0.0.3

6 years ago

0.0.2

6 years ago

0.0.1

6 years ago

1.0.0

6 years ago