Countdown Timer

Create a time wrapper element and give it a datetime attribute with a valid date string. This date string will be used to count to (if it’s in the future), or from (if it’s in the past, and the allowNegative setting is enabled). Make sure the element is targetable with a selector that can be passed to the JavaScript. Refer to the JavaScript section below on how to initialize.

For accessibility purposes, we strongly recommend adding some fallback content inside the time element which can be shown if the JS is unable to run. This content will be replaced by the countdown elements once the JS is initialized.

You can create multiple instances on the same page—each will count down independently, as long as they can be targeted by some selector and each contains a valid datetime attribute. To create multiple timer instances with shared settings, give the time elements the same selector and invoke them once using that selector in JS. To create multiple timer instances with different settings, give the time elements different selectors and invoke them separately in JS.

<time class="countdown-timer" datetime="2046-01-01T00:00:00">
	<!-- Some fallback content, perhaps the date string itself or a message to users or machines that can't view this component with JS. -->
	2046-01-01T00:00:00
</time>

import CountdownTimer from '@10up/countdown-timer';

new CountdownTimer('.countdown-timer', {
  onCreate: function (instance) {
    console.log('onCreate callback', instance);
  },
  onEnd: function (instance) {
    console.log('onEnd callback', instance);
  },
  onTick: function (instance) {
    console.log('onTick callback', instance);
  },

  allowNegative: false,
  compact: false,
  padValues: false,
  separator: ', ',
  showZeroes: false,
  years: {
    allowed: true,
    singular: 'year',
    plural: 'years'
  },
  weeks: {
    allowed: true,
    singular: 'week',
    plural: 'weeks'
  },
  days: {
    allowed: true,
    singular: 'day',
    plural: 'days'
  },
  hours: {
    allowed: true,
    singular: 'hour',
    plural: 'hours'
  },
  minutes: {
    allowed: true,
    singular: 'minute',
    plural: 'minutes'
  },
  seconds: {
    allowed: true,
    singular: 'second',
    plural: 'seconds'
  }
} );

						

let countdownTimer = new TenUp.CountdownTimer( '.countdown-timer', {
  onCreate: function( instance ) {
    console.log( 'onCreate callback', instance );
  },

  onEnd: function( instance ) {
    console.log( 'onEnd callback', instance );
  },

  onTick: function( instance ) {
    console.log( 'onTick callback', instance );
  },

  allowNegative: false,
  compact: false,
  padValues: false,
  separator: ', ',
  showZeroes: false,
  years: {
    allowed: true,
    singular: 'year',
    plural: 'years'
  },
  weeks: {
    allowed: true,
    singular: 'week',
    plural: 'weeks'
  },
  days: {
    allowed: true,
    singular: 'day',
    plural: 'days'
  },
  hours: {
    allowed: true,
    singular: 'hour',
    plural: 'hours'
  },
  minutes: {
    allowed: true,
    singular: 'minute',
    plural: 'minutes'
  },
  seconds: {
    allowed: true,
    singular: 'second',
    plural: 'seconds'
  }
} );

Installation

This component accepts two arguments, the selector for the countdown timer container, and an optional settings object containing callback functions and other options.

API

This component accepts two arguments, the selector for the component container and an object containing optional settings and callbacks.

Supported Intervals

The timer can display values for the following time intervals:

• years
• weeks
• days
• hours
• minutes
• seconds

Why no months?

Since various months can contain different numbers of days, a month is not an exact unit of time, so it’s not as useful for counting toward or away from a specific point in time. All supported intervals contain an exact number of seconds. The one exception is years, which can contain either 365 or 366 days. The component will factor this into its calculations by adding an extra day for each leap year as necessary.

Methods

General Settings

Interval Settings

You may provide settings for each supported interval. You can give each interval property an object with the following options:

Callbacks

OnTick Callback

The onTick callbackCalled with a single argument, an object that contains the following properties related to the timer instance that called it:

	{
	element,    // {object}  The top-level HTML element of the timer which invoked the callback.
	time,       // {number}  The time this timer is counting to/from, in UNIX format.
	diff,       // {number}  The number of milliseconds between `time` and the moment `onTick` was called.
	isNegative, // {boolean} If `true`, `time` is in the past and `diff` is a negative number.
	years,      // {number}  Number of years in `diff`.
	weeks,      // {number}  Number of weeks in `diff`.
	days,       // {number}  Number of days in `diff`.
	hours,      // {number}  Number of hours in `diff`.
	minutes,    // {number}  Number of minutes in `diff`.
	seconds     // {number}  Number of seconds in `diff`.
}

Dealing with Time Zones

The time displayed by the component will depend on the local time zone of the browser rendering it. You can control the behavior of the component by providing a date string that considers time zone:

If you provide a datetime without any time zone specification, the component calculates the remaining time based on the user’s local time zone. This is useful if you want to count down to an event relative to local time zone.

• For example, to count down to midnight on New Year’s Day in the year 2046 in the user’s local time zone: 2046-01-01T00:00:00

If you provide a datetime in a specific time zone, the component which will factor in the difference between the specified time zone and the user’s local time zone. This is useful if you want to count down to an event that occurs at an exact time in a specific time zone.

• For example, to count down to midnight on New Year’s Day in the year 2046 in Eastern Standard Time (EST): 2046-01-01T00:00:00-04:00

If you provide a datetime in UTC (with a Z suffix to denote UTC), the component will factor in the difference between UTC and the user’s local time zone. This is useful if you want to count down to an exact time in UTC.

• For example, to count down to midnight on New Year’s Day in the year 2046 in UTC: 2046-01-01T00:00:00Z

If the component does not contain a datetime attribute, the datetime attribute is not a valid date string, or the date string is a date in the past, the component will display zeroes for all intervals.

• More information about valid date and time strings in HTML