1.0.0 • Published 4 years ago

countdown-tmr v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

Countdown

Simple, lightweight and very easy to use Countdown package.

Installation

npm install countdown-tmr

import Countdown from 'countdown-tmr';
const elm = document.querySelector('#my-countdown')
const options = {
  date: '3 Jul 2020 08:00:00',
  labels: {
    days: 'd',
    hours: 'h',
    minutes: 'm',
    seconds: 's'
  }
}
const countdown = new Countdown(elm, settings).play()

Properties

PropertyTypeDefault Value
datestring24 hours from current date. Format: '3 Jul 2020 08:00:00'
playingbooltrue
labelsobjectdays: 'days',hours: 'hours'minutes: 'minutes',seconds: 'seconds'

Methods

MethodFunction
playInitializes the countdown
stopStops the countdown
getRemainingReturns the remaining value (in miliseconds) of a given argument. Available arguments are 'days', 'hours', 'minutes' and 'seconds'.

Events

Events can be accessed through the on() method.

on(eventType, callbackFn)

Events are triggered every time certain value changes (e.g. from 2 hours to 1 hour). Here is the events list:

  • on('days', callbackFn)
  • on('hours', callbackFn)
  • on('minutes', callbackFn)
  • on('seconds', callbackFn)
coundown.on('hours', myCallback)

function myCallback() {
  console.log('an hour less to go')
}