The Timer component for Retool Apps

A button to record elapsed time.

Demo

Settings

Timer includes the following configurable options when building apps in the IDE.

Event handlersFormatHiddenIntervalShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesTime elapsed sinceValue

Properties

All properties for Timer with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

elapsedTimeMs

number

The time, in milliseconds, that has elapsed.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type. Refer to the events section for a list of supported events.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

format

enum

The formatting style to use.

Values

decimal	Decimal.
percent	Percent.
currency	Currency.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

interval

number

The interval, in milliseconds, at which the timer updates.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

isRunning

boolean

Whether the timer is running.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

timeElapsedSince

---

timeElapsedSinceEnabled

boolean

Whether to display elapsed time.

---

value

The value.

---

Methods

JavaScript API methods for interacting with Timer. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

timer.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setValue

Set the current value.

timer.setValue(value)

Parameters

value

number

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

reset

---

stop

---

toggle

---