Countdowns

Use countdowns to illustrate the time remaining to an important deadline.


Overview

Here’s an example countdown:

21 years until The Singularity arrives.

Countdowns have a reveal animation in order to draw attention. They have customizable syntax and disappear automatically once the deadline has passed.

Countdowns are also user-dismissible by default. Dismissible countdowns will display a Countdown dismiss icon icon on the right-hand edge.

Adding a Countdown

Currently, countdowns can only be implemented by using the shortcode (see the below documentation).


Technical Details

Countdowns can be implemented with the shortcode cl-countdown.

[cl-countdown deadline="January 1, 2045" event="The Singularity arrives"]

Attributes

deadline

(string) (required)

The deadline specified in any PHP date/time format

event

(string) (optional)

The event text

(default value: the event)

until

(string) (optional)

The syntax for the countdown message before the deadline

(default value: until)

is_today

(string) (optional)

The syntax for the countdown message on the day of the event

(default value: is today)

passed

(string) (optional)

The syntax for the countdown message after the deadline

(default value: passed)

link

(string) (optional)

Set a link for the countdown

(default value: none)

show_expired

(bool) (optional)

Set to continue displaying the countdown once it’s expired

(default value: false)

dismissible

(bool) (optional)

Set to prevent the countdown from being dismissible

(default value: true)

class

(string) (optional)

Set custom CSS class(es)

(default value: none)