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.
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Mutability |
| |||||||||
| Allowed Values |
| |||||||||
| Default | |
Examples
4px 8px
tooltipText
The tooltip text to display next to the label on hover.
| Type | string | ||||
| Format | Markdown | ||||
| Mutability |
| ||||
| Default | |
Examples
Submit
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
options Required
The scroll options.
Object Properties
behavior Required
The scroll behavior.
Supported Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block Required
The scroll position relative to the component.
Supported 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. |
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.
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
hidden
Whether this object is hidden from view.
Examples
Hide time.
time.setHidden(true);
Unhide time.
time.setHidden(false);
time.setValue(id, pluginType, global, isHiddenOnDesktop, isHiddenOnMobile, style, maintainSpaceWhenHidden, showInEditor, margin, value)
Parameters
id
pluginType
global
isHiddenOnDesktop
isHiddenOnMobile
style
maintainSpaceWhenHidden
showInEditor
margin
value
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. Use event handlers to trigger queries or other actions in response to events.