time-input
Last updated
Last updated
time-input allows users to enter a time (bound to a datetime field) using a time picker.
Version compatibility
time-input was introduced in version 4.87.0 of the JourneyApps Runtime.
bindlabelrequiredalign-contentalign-labelclear-button-visibilityclear-iconOptional
Type: string
Default: "fa-times"
Specify the icon on the right side of the input that appears when a time was selected. Find a list of available icons here.
disablederror-messageicon-positionidlabel-caselabel-colormodifier-texton-changeplaceholdershow-if and hide-iftime-formatOptional
Type: 12h | 24h
Default: 12h
Specify the clock format when users enter a time. Example:
12h format: 3:32 PM
24h format: 15:32
time-iconOptional
Type: string
Default: "fa-clock"
Specify the icon on the right side of the input that appears before a time was selected. Find a list of available icons here.
The following component methods are available when an id is assigned to the component and component.timeInput({id:'my-id'}) is called from JS/TS:
clearProgrammatically clear the selected date and time bound to the time-input component.
pickTimeProgrammatically open the time picker to allow the user to select or update a time value.
scrollIntoViewProgrammatically scroll until the time-input is visible in the view.
