Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TokenShort description
displayNameHuman-readable name shown in the structure panel.
dateTarget date/time for the countdown (Date or parseable string).
formatWhich time units to show (days / hours / minutes / seconds).
updateIntervalInMSRefresh rate in milliseconds (default 1000).
expiredTextText shown once the countdown reaches/passes the target time.
widthAutoAuto-size to content (true) or fill container (false).
showTimerIconToggle a decorative timer/clock icon.
eventsContainer for the component’s event handlers.
ON_INIT (eventsEvents)Fires when the component is initialized (setup).
ON_DESTROY (eventsEvents)Fires when the component is removed (cleanup).
ON_GLOBAL_PARAMETERS_CHANGE (eventsEvents)Fires when relevant global parameters change.
ON_DATA_HUB_CHANGE (eventsEvents)Fires when the Data Hub context/state changes.
ON_EXPIRED (eventsEvents)Fires once when the target time is reached/passed.

...

  • events – Configures the events that the component can trigger and respond to.
    • ON_INIT – Triggered when the label component is initialized. Can be used to perform setup operations like setting initial context values.
    • ON_DESTROY – Triggered when the label component is removed from the DOM. Useful for cleanup operations and releasing resources.
    • ON_GLOBAL_PARAMETERS_CHANGE – Triggered when global parameters that might affect the component change.
    • ON_DATA_HUB_CHANGE - Emitted whenever the Data Hub’s active context or state changes.
    • ON_EXPIRED - Fires once when the countdown reaches or passes its target time.

...