The Time component for Retool Apps
An input field to select or enter a time.
Time can display values using different time zones and adjust for the time difference. For example, January 1, 2021 at 11:00 PM (UTC) can be displayed as January 2, 2021 at 8:00 AM (UTC+9:00).
For more information about using the Time component, refer to the dates and times guide.
Properties
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
Examples
falsequery1
falsebutton1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on desktop |
| Default | false |
Examples
falsetrue
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on mobile |
| Default | true |
Examples
falsetrue
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
| Default | false |
Examples
falsetrue
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Spacing > Margin | |||||||||
| Allowed Values |
| |||||||||
| Default | 4px 8px |
Examples
false4px 8px
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
| Default | false |
Examples
falsetrue
tooltipText
The tooltip text to display next to the label on hover.
| Type | string |
| Format | Markdown |
| Configurability | Inspector > Content > Add-ons > Helper text |
| Default | null |
Examples
falseSubmit
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
time.clearValidation()
Examples
Clear the validation message from time.
time.clearValidation();
time.clearValue()
Examples
Clear the current value of time.
time.clearValue();
time.focus()
Examples
Set focus on time.
time.focus();
time.resetValue()
Examples
Reset the current value of time.
time.resetValue();
time.scrollIntoView()
Scrolls the canvas or parent container so that the selected component appears in the visible area.
time.scrollIntoView(options)
Parameters
Object Properties
behavior
The scroll behavior.
| Type | string | ||||||
| Allowed Values |
|
block
The scroll position relative to the component.
| Type | string | ||||||||||
| Allowed Values |
|
Examples
Scroll the minimum amount to immediately bring time into view.
time.scrollIntoView({behavior: 'auto', block: 'nearest'});
time.setDisabled()
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
time.setDisabled(disabled)
Parameters
disabled
Whether input, interaction, selection, or triggering is disabled.
| Type | boolean |
| Format | True/False |
| Default | |
Examples
true
Examples
Disable time.
time.setDisabled(true);
Enable time.
time.setDisabled(false);
time.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
time.setHidden(hidden)
Parameters
Examples
true
Examples
Hide time.
time.setHidden(true);
Unhide time.
time.setHidden(false);
time.setValue(id, pluginType, isHiddenOnDesktop, isHiddenOnMobile, style, maintainSpaceWhenHidden, showInEditor, margin, value)
Parameters
Examples
Set the current value of time to userValue.
time.setValue(userValue);
time.validate()
Examples
Validate the value of time.
time.validate();
Events
Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.
| Event | Description |
|---|---|
| Blur | The input field is deselected. |
| Change | The value is changed. |
| Focus | The input field is selected. |
| Submit | The value is submitted. |