Skip to main content

Time Picker

The Time Picker component can be used for selecting time without date input. It offers customizable formats, validation, and styling.

Properties

PropertyDescriptionExpected Value
LabelThe text to be used as the label for the Time Picker.String (e.g., Time of Arrival).
Time FormatSelect the time format from the dropdown. Default time format is HH:mm.Select from dropdown (e.g. hh:mm A).
Default valueThe default value that the component will hold when the app is loaded.String (e.g., 11:00).

Events

EventDescription
On selectTriggers whenever the user selects a time.
On focusTriggers whenever the user clicks inside the time picker.
On blurTriggers whenever the user clicks outside the time picker.
info

Check Action Reference docs to get the detailed information about all the Actions.

Component Specific Actions (CSA)

Following actions of component can be controlled using the Component Specific Actions(CSA), which can be triggered by an event or by the given RunJS query:

Action
Description
How To Access
setTime( )Sets time in the time picker component.components.timepicker1.setTime(time)
setValue( )Sets both the date and time value.components.timepicker1.setValue(value)
setMinTime( )Sets the minimum time that can be selected in the time picker.components.timepicker1.setMinTime(value)
setMaxTime( )Sets the maximum time that can be selected in the time picker.components.timepicker1.setMaxTime(value)
clearValue( )Clears the value of the time picker.components.timepicker1.clearValue()
setValueinTimeStamp()Sets the date and time value in the Unix format.components.timepicker1.setValueinTimeStamp(value)
setDisplayTimezone( )Sets the timezone in which the selected time will be displayed.components.timepicker1.setDisplayTimezone(value)
setStoreTimezone( )Specifies the timezone in which the selected time will be stored.components.timepicker1.setStoreTimezone(value)
setVisibility( )Sets the visibility state of the time picker.components.timepicker1.setVisibility()
setLoading( )Sets the loading state of the time picker.components.timepicker1.setLoading()
setDisable( )Disables the time picker.components.timepicker1.setDisable()
setFocus( )Sets the focus of the cursor on the time picker.components.timepicker1.setLoading()
setBlur( )Removes the focus of the cursor from the time picker.components.timepicker1.setBlur()

Exposed Variables

Following exposed variables can be dynamically accessed using the given JS query:

Variables
Description
How To Access
valueThis component holds the value entered in the Time Picker component.{{components.timepicker1.value}}
labelHolds the value of the component's label.{{components.timepicker1.label}}
minTimeHolds the earliest selectable time.{{components.timepicker1.minTime}}
maxTimeHolds the latest selectable time.{{components.timepicker1.maxTime}}
selectedTimeHolds the value of selected time.{{components.timepicker1.selectedTime}}
unixTimestampHolds the value in UNIX format.{{components.timepicker1.unixTimestamp}}
displayValueHolds the display value of the component.{{components.timepicker1.displayValue}}
timeFormatReturns the time format as a string.{{components.timepicker1.timeFormat}}
isValidIndicates if the input meets validation criteria.{{components.timepicker1.isValid}})
isMandatoryIndicates if the field is Mandatory.{{components.timepicker1.isMandatory}}
isLoadingIndicates if the component is loading.{{components.timepicker1.isLoading}}
isVisibleIndicates if the component is visible.{{components.timepicker1.isVisible}}
isDisabledIndicates if the component is disabled.{{components.timepicker1.isDisabled}}

Validation

Validation Option
Description
Expected Value
Min TimeSpecifies the earliest selectable time. Any time before the Min Time will be disabled.String (for e.g., 05:35)
Max TimeSpecifies the latest selectable time. Any time after the Max Time will be disabled.String (for e.g., 15:45)
Custom validationAdd a custom validation for the time input using the ternary operator.Custom Validation Statement (for e.g., {{moment(components.timepicker1.value).format('HH:mm') > moment().format('HH:mm') ? true : 'You are late!' }})
Make this field mandatoryMakes the field mandatory.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.

Additional Actions

Action
Description
Configuration Options
Loading stateEnables a loading spinner, often used with isLoading to indicate progress.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
VisibilityControls component visibility.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
DisableEnables or disables the component.Enable/disable the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
TooltipProvides additional information on hover.String (e.g., Select the time of arrival.).

Devices

PropertyDescriptionExpected Value
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.

Styles

Label

PropertyDescription
Label ColorSets the color of the label text.
AlignmentDetermines the label's position, choose between top/side and left/right alignment.
WidthSpecifies the percentage of the component’s width that the label should occupy.

Color

PropertyDescription
BackgroundSets the background color of the component.
BorderDefines the color of the component’s border.
AccentSpecifies the accent color used for highlights or focus indicators.
TextSets the text color inside the component.
Error textColor applied to error messages.

Input Field

PropertyDescription
IconAdds an icon to the component, usually for visual cues or actions.
Icon ColorSets the color of the icon.
Icon PositionDefines the position of the icon (e.g., left, right).
Border radiusControls the roundness of the component's input field.
Box shadowApplies shadow styling to the input field.
PaddingSets the internal spacing between the content and the input field edges.
info

Any property having fx button next to its field can be programmatically configured.