Template:Countdown/doc
The Countdown template displays a countdown box showing the number of days until some event. Once the date has passed, the countdown box will disappear.
Parameters
|Date= |
The date of the event. This should be the first parameter if parameter names are not used. Dates can be specified in a number of ways--see the examples below for some alternatives. Note that if the date uses hyphens as separators, it must be in year-month-day order (e.g., 2025-10-25), while if slashes are used, it must be in month/day/year order (e.g., 10/25/2025). | |
|Event= |
The event that is being counted down to. This should be the second parameter if parameter names are not used. The default is event if this parameter is omitted. | |
|Until= |
If you want a different term than "until" in the caption, use this parameter to specify what to use instead | |
Formatting parametersA number of formatting parameters are also available to customize the display of the countdown box. | ||
|Font= |
Set the font face to display the countdown in. The default font is Mono. You can specify a fallback list where the second font will be used if the first is not available, and the third if neither the first or second are available, . . . by listing multiple fonts, separated by commas. | |
|Size= |
Set the font size in pixels for the countdown to appear in. The default is 74. | |
|Alignment= |
Set the alignment for the countdown. The default is "right". Please make sure to use quotes around this variable such as "left". | |
|Color= |
Set the font color for the countdown. The default is black. | |
|Background= |
Set a background color for the font to appear in. The default is #fdfdfa. | |
|Width= |
Set the width, in pixels, for the countdown box. The default is 250. | |
|Border= |
Set a color for the border lines of the box around the countdown. The default is #ccc. | |
|shadow= |
Set a color for the shadow for the countdown box. Note that the shadow will not appear for some users, depending upon the browser they are using. The default is #ccc. | |
|CaptionFont= |
Set the font face for the caption text below the countdown. The default is Cambria, serif. | |
|CaptionSize= |
Set the size in pixels for the caption text. The default is 18. | |
|CaptionColor= |
Set a color for the caption text. The default is #2f4f4f. | |
Usage
| What you type | What you get | |||
|---|---|---|---|---|
{{ Countdown | 10/26/2025| tomorrow}} |
| |||
{{ Countdown | 10/25/25| today}} |
| |||
{{ Countdown | date=October 24, 2025| event=yesterday}} |
| |||
{{ Countdown | Nov 1, 25}} |
| |||
{{ Countdown | Date=2025-12-25| Event=Christmas| until=left to shop until| color=white| border=red| background=Green| CaptionColor=Red}}
|
| |||
{{ Countdown }} |
No date specified for countdown
|
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Date | Date | The date of the event. This should be the first parameter if parameter names are not used. Dates can be specified in a number of ways--see the examples below for some alternatives. Note that if the date uses hyphens as separators, it must be in year-month-day order (e.g., 2021-03-10), while if slashes are used, it must be in month/day/year order (e.g., 3/10/2021). | Unknown | suggested |
| CaptionFont | CaptionFont | no description | Unknown | optional |
| Captionfont | Captionfont | no description | Unknown | optional |
| captionfont | captionfont | no description | Unknown | optional |
| Alignment | Alignment | no description | Unknown | optional |
| alignment | alignment | no description | Unknown | optional |
| Background | Background | no description | Unknown | optional |
| background | background | no description | Unknown | optional |
| Border | Border | no description | Unknown | optional |
| border | border | no description | Unknown | optional |
| Width | Width | no description | Unknown | optional |
| width | width | no description | Unknown | optional |
| Shadow | Shadow | no description | Unknown | optional |
| shadow | shadow | no description | Unknown | optional |
| Color | Color | no description | Unknown | optional |
| color | color | no description | Unknown | optional |
| Font | Font | no description | Unknown | optional |
| font | font | no description | Unknown | optional |
| Size | Size | no description | Unknown | optional |
| size | size | no description | Unknown | optional |
| CaptionColor | CaptionColor | no description | Unknown | optional |
| Captioncolor | Captioncolor | no description | Unknown | optional |
| captioncolor | captioncolor | no description | Unknown | optional |
| CaptionSize | CaptionSize | no description | Unknown | optional |
| Captionsize | Captionsize | no description | Unknown | optional |
| captionsize | captionsize | no description | Unknown | optional |
| Until | Until | no description | Unknown | optional |
| until | until | no description | Unknown | optional |
| Event | Event | no description | Unknown | suggested |
| event | event | no description | Unknown | optional |