Time

A combination select and input field to select a time from a dropdown or directly enter it as text. It supports custom time formats, and can perform validation of required field, minimum or maximum times, and custom rules.

Properties

Available properties for Time with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionvaluestring

The current value.

disabledboolean

Whether user input, interaction, or selection is disabled.

displayTimeZonestring

The time zone (UTC offset) that applies to the display value. Uses the time zone reported by the browser if set to local.

formDataKeystring

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

formattedValuestring

The selected value in the specified format.

hiddenboolean

Whether the component is visible.

hideValidationMessageboolean

Whether to hide the validation message if the invalid is true.

iconAfterIconKey

The icon to display after the primary content.

iconBeforeIconKey

The icon to display before the primary content.

invalidboolean

Whether the current value has failed any validation rules.

labelstring

The text to display as a label for the input field.

labelAlign'left' | 'right'

The horizontal alignment of the label.

labelCaptionstring

The additional text to display with the label.

labelPosition'left' | 'top'

The position of the label relative to the input field.

labelWidthnumber

The label width, in the unit specified in labelWidthUnit.

labelWidthUnit'%' | 'px' | 'col'

The specified units for labelWidth.

labelWrapboolean

Whether the label can wrap to multiple lines.

loadingboolean

Whether to display a loading indicator.

maintainSpaceWhenHiddenboolean

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

manageTimeZoneboolean

Whether to adjust the value and display value of time zones using valueTimeZone and displayTimeZone respectively.

marginstring

The amount of margin to render outside of the component.

maxTimestring

The latest time to allow.

minTimestring

The earliest time to allow.

minuteStepnumber | null

The step size for time options, in minutes.

readOnlyboolean

Whether the value is read only and cannot be modified.

requiredboolean

Whether the input is required for validation.

showClearboolean

Whether to display a button to clear the current value of the input field.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

textAfterstring

The text to display after the primary content.

textBeforestring

The text to display before the primary content.

timeFormatstring

The displayed time format.

timePlaceholderstring

The text to display in the input field when empty.

tooltipTextstring

The text to display in a tooltip on hover or focus.

validationMessagestring

The validation message to display if the input is invalid.

valueTimeZonestring

The time zone (UTC offset) to encode in value. Uses the time zone reported by the browser if set to local.

Events

Events are triggered by user interactions with Time. Use event handling to trigger queries or other actions in response to events.

NameDescriptionChange

A user changes the current value.

Focus

A user selects the input field.

Blur

A user deselects the input field.

Submit

A user submits the current value.

Methods

Methods for interacting with Time. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionsetValue(value: string | number)

Set the current value.

clearValue()

Clear the current value.

scrollIntoView(options: any)

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

validate()

Validates the value of the input field.

clearValidation()

Clear the validation message from the input field.

setHidden(hidden: boolean)

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

setDisabled(disabled: boolean)

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

resetValue()

Reset value to the default value.

focus()

Set focus on the input field.

Related components