Bonsaibauer: 1 revision imported: Import Star Citizen Modules

2026-11-04T22:22:13Z

1 revision imported: Import Star Citizen Modules

← Older revision		Revision as of 22:22, 4 November 2026
(No difference)

starcitizen>Alistar Bot: Sync from Git (7721bcf) (via create-page on MediaWiki MCP Server)

2026-09-11T23:53:14Z

Sync from Git (7721bcf) (via create-page on MediaWiki MCP Server)

New page

{{documentation|git=true}}

A live countdown display, split by responsibility: the module renders the markup, the data attributes, and a no-JS fallback date; a mainpage gadget computes the actual remaining time and animates the digit stack client-side.

Required by [[Module:Mainpage/Event]] and [[Module:Mainpage/Event/Legacy]]; not invoked from templates.

== For module editors ==

=== API ===

<code><nowiki>p.render(props)</nowiki></code> returns <code><nowiki><templatestyles></nowiki></code> + markup, or raises a Lua error when <code><nowiki>ends</nowiki></code> is missing or either date is not readable by the content language's date formatter (<code><nowiki>mw.language:formatDate</nowiki></code>); both current callers wrap the call in <code><nowiki>pcall</nowiki></code>.

{| class="wikitable"
|-
! Field
! Type
! Description
|-
| <code><nowiki>starts</nowiki></code>
| ISO 8601 string
| Optional. Omit for something already under way; with it the gadget can also render a "starts in" tense.
|-
| <code><nowiki>ends</nowiki></code>
| ISO 8601 string
| Required.
|-
| <code><nowiki>label</nowiki></code>
| <code><nowiki>string</nowiki></code>
| Overrides the gadget's tense-derived label. Rarely wanted; the point is that the label follows the dates.
|-
| <code><nowiki>class</nowiki></code>
| <code><nowiki>string</nowiki></code>
| Extra class on the root.
|}

<code><nowiki>p.main(frame)</nowiki></code> is the <code><nowiki>#invoke</nowiki></code> entry point (reads <code><nowiki>starts</nowiki></code>/<code><nowiki>ends</nowiki></code>/<code><nowiki>label</nowiki></code>/<code><nowiki>class</nowiki></code> via [[Module:Arguments]]).

=== Gotchas ===

* The module deliberately does not compute remaining time: a value worked out at parse time freezes into the parser cache and can go arbitrarily stale. It emits the dates as <code><nowiki>data-gadget-mainpage-countdown-start</nowiki></code>/<code><nowiki>-end</nowiki></code> (+ <code><nowiki>-label</nowiki></code>) attributes for the gadget, and renders a no-JS fallback: the end date alone, or a <code><nowiki>starts – ends</nowiki></code> range with the start year dropped when both dates share one.
* An unreadable date is a hard Lua error, not a silent empty render, because a typo here has to be loud.

=== Styles ===

<code><nowiki>class = 't-countdown--flat'</nowiki></code> is the module's own modifier for lying the clock down into a horizontal strip regardless of viewport (it also does this automatically below 639px). The gadget replaces the fallback with a live digit stack, adding <code><nowiki>t-countdown--live</nowiki></code> and, for colour, one of <code><nowiki>--upcoming</nowiki></code> or <code><nowiki>--running</nowiki></code>; <code><nowiki>--ended</nowiki></code> carries no colour rule at all, deliberately falling back to the root's <code><nowiki>--color-subtle</nowiki></code>.

Module:Countdown/doc - Revision history

Bonsaibauer: 1 revision imported: Import Star Citizen Modules

starcitizen>Alistar Bot: Sync from Git (7721bcf) (via create-page on MediaWiki MCP Server)