Time Picker
Ant Design
The Time Picker component is Ant Design's time input. Users pick a time of day from a dropdown, such as a delivery slot or a shift start.
Properties​
Property | Description | Expected Value |
|---|---|---|
| Label | Text shown above the field, or beside it when Layout is horizontal. | Text. Default: Time |
| Extra | Help text shown under the field. A validation message replaces it while the value is not valid. | Text |
| Tooltip | Text shown from an info icon after the label. | Text |
| Layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | vertical, horizontal. Default: vertical |
| Value | The starting time in 24-hour form, such as 09:30 or 14:05:30. | Text |
| Format | How the time is shown in the field, such as HH:mm, HH:mm:ss or h:mm a. Seconds in the format add seconds to Value, which stays in 24-hour form. | Text. Default: HH:mm |
| Use 12 hours | Shows the time on a 12-hour clock with AM and PM. | On or off. Default: Off |
| Hour step | Gap between the hours offered, such as 2 for every other hour. | Number. Default: 1 |
| Minute step | Gap between the minutes offered, such as 15 for quarter hours. | Number. Default: 1 |
| Placeholder | Hint text shown while no time is picked. | Text. Default: Pick a time |
| Allow clear | Shows a clear icon in the field once a time is picked. | On or off. Default: On |
| Variant | Border style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line. | outlined, filled, borderless, underlined. Default: outlined |
| Size | Height and text size of the field. | small, middle, large. Default: middle |
Additional Actions​
Each of these can be switched on or off, or set with a logical expression by clicking fx.
Property | Description | Expected Value |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
| Dynamic height | Lets the component grow with its content in the running app instead of keeping a fixed height. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows the component in the mobile layout. | On or off. Default: Off |
Events​
Add a handler from the Events section of the properties panel. See Event Triggers for the steps.
Event | Description |
|---|---|
| On change | Triggers when the picked time changes, including when it's cleared. |
Component Specific Actions (CSA)​
Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.
Action | Description | How To Access |
|---|---|---|
| Set field value | Sets the time to the given Value, such as 14:30. Text that isn't a time is ignored, and empty text clears the field. | components.timepicker1.setFieldValue("") |
| Reset field | Sets the field back to the Value property. | components.timepicker1.resetFields() |
| Set visibility | Shows the component when true, hides it when false. | components.timepicker1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.timepicker1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.timepicker1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
label | Text shown above the field, or beside it when Layout is horizontal. | {{components.timepicker1.label}} |
extra | Help text shown under the field. A validation message replaces it while the value is not valid. | {{components.timepicker1.extra}} |
tooltip | Text shown from an info icon after the label. | {{components.timepicker1.tooltip}} |
layout | Where the label sits: vertical puts it above the field, horizontal puts it to the left. | {{components.timepicker1.layout}} |
value | The starting time in 24-hour form, such as 09:30 or 14:05:30. | {{components.timepicker1.value}} |
format | How the time is shown in the field, such as HH:mm, HH:mm:ss or h:mm a. Seconds in the format add seconds to Value, which stays in 24-hour form. | {{components.timepicker1.format}} |
use12Hours | Shows the time on a 12-hour clock with AM and PM. | {{components.timepicker1.use12Hours}} |
hourStep | Gap between the hours offered, such as 2 for every other hour. | {{components.timepicker1.hourStep}} |
minuteStep | Gap between the minutes offered, such as 15 for quarter hours. | {{components.timepicker1.minuteStep}} |
placeholder | Hint text shown while no time is picked. | {{components.timepicker1.placeholder}} |
allowClear | Shows a clear icon in the field once a time is picked. | {{components.timepicker1.allowClear}} |
variant | Border style of the field. filled uses a light background, borderless has no border, and underlined shows only a bottom line. | {{components.timepicker1.variant}} |
size | Height and text size of the field. | {{components.timepicker1.size}} |
isVisible | Whether the component is visible. | {{components.timepicker1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.timepicker1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.timepicker1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 0px 0px 0px #00000040 |
A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.