File size: 1,775 Bytes
0ad74ed |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
"""gr.Timer() component."""
from __future__ import annotations
from typing import TYPE_CHECKING
from gradio_client.documentation import document
from gradio.components.base import Component
from gradio.events import Events
if TYPE_CHECKING:
pass
@document()
class Timer(Component):
"""
Special component that ticks at regular intervals when active. It is not visible, and only used to trigger events at a regular interval through the `tick` event listener.
"""
EVENTS = [
Events.tick,
]
def __init__(
self,
value: float = 1,
*,
active: bool = True,
render: bool = True,
):
"""
Parameters:
value: Interval in seconds between each tick.
active: Whether the timer is active.
render: If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.
"""
self.active = active
super().__init__(value=value, render=render)
def preprocess(self, payload: float | None) -> float | None:
"""
Parameters:
payload: The interval of the timer as a float or None.
Returns:
The interval of the timer as a float.
"""
return payload
def postprocess(self, value: float | None) -> float | None:
"""
Parameters:
value: The interval of the timer as a float or None.
Returns:
The interval of the timer as a float.
"""
return value
def api_info(self) -> dict:
return {"type": "number"}
def example_payload(self):
return 1
def example_value(self):
return 1
|