A component that emits an event repeatedly at specified time intervals, enabling time-based refresh.

Fields

NameTypeDescriptionOptions
Interval (ms)NumberHow much time to wait between ticks. A tick is considered finished when its event is handled.-
ActiveBooleanWhether the timer should trigger tick events.
  1. Yes
  2. No
AccentColor--
Custom CSS classesTextCSS classes, separated by spaces. You can define classes in custom stylesheets.-

Events

Low code usage

This component can be declared directly in Python, using backend-driven UI.

ui.Timer(content={
        "intervalMs": 0.0, # Union[float, str] 
        "isActive": "yes", # str [yes, no]
        "accentColor": "", # str 
        "cssClasses": "", # str 
    },
    handlers={
        "wf-tick": handle_event,
    }
)

A function, in this example handle_event, should be implemented in your code to handle events.

def handle_event(state, payload, context, ui):
  pass

Reference