Skip to main content

TimePicker

The TimePicker component allows merchants to select times using an interactive picker interface. Use it when merchants benefit from visual time selection rather than typing exact times.

For direct text entry when merchants know the exact time, use TimeField.

Support
Targets (18)

Supported targets

Use cases

  • Visual selection: Provide visual time selection for appointments or scheduling workflows.
  • Quick selection: Enable quick time selection for business hours or delivery windows.
  • Touch optimization: Support touch-optimized time input on POS devices.
  • User-friendly: Allow users to select times without remembering specific formats.

Anchor to examplesExamples

Anchor to example-select-times-with-a-time-pickerSelect times with a time picker

Select times using a TimePicker component. This example shows a basic time picker for selecting hours and minutes.

Select times with a time picker

Select times with a time picker

<s-button command="--show" commandFor="time-picker">
Show
</s-button>
<s-time-picker
value="9:41"
id="time-picker"
/>

Anchor to example-control-picker-visibilityControl picker visibility

Control TimePicker visibility programmatically using the command system with show and hide methods. This example demonstrates using button commands to display or dismiss the time picker, enabling custom trigger patterns for time selection workflows.

Control picker visibility

<>
<s-button command="--show" commandFor="time-picker">
Select Time
</s-button>
<s-time-picker
id="time-picker"
value="14:30"
onChange={(event) => console.log('Time selected:', event.currentTarget.value)}
/>
</>;

Anchor to example-handle-time-selection-eventsHandle time selection events

Subscribe to time selection events to respond when merchants pick a time. This example shows how to handle onChange events to capture selected times, enabling validation, scheduling logic, or dynamic updates based on the chosen time.

Handle time selection events

<s-time-picker
value="14:30"
onInput={(event) => console.log('Input:', event.currentTarget.value)}
onChange={(event) => console.log('Change:', event.currentTarget.value)}
onFocus={(event) => console.log('Focused')}
onBlur={(event) => console.log('Blurred')}
/>

Anchor to propertiesProperties

Configure the following properties on the TimePicker component.

Anchor to id
id
string

A unique identifier for the element.

Anchor to value
value
string
Default: ''

Current selected value.

The default, '', means no time is selected.

The value must be a 24-hour time in HH:mm:ss format, with leading zeros.

Examples: "00:00:00", "09:05:00", "23:59:00", "14:03:30".

This follows the HTML time input value format, which is always 24-hour with leading zeros regardless of UI presentation.

See: https://developer.mozilla.org/docs/Web/HTML/Element/input/time

If the provided value is invalid, '' is used as the value.

Anchor to eventsEvents

The TimePicker component provides event callbacks for handling user interactions. Learn more about handling events.

Anchor to blur
blur
(event: <"s-time-picker">) => void

Callback when the time picker is dismissed.

Anchor to change
change
(event: <"s-time-picker">) => void

Callback when the user selects a time from the picker that is different to the current value.

Anchor to focus
focus
(event: <"s-time-picker">) => void

Callback when the time picker is revealed.

Anchor to input
input
(event: <"s-time-picker">) => void

Callback when the user selects a time from the picker.

Anchor to best-practicesBest practices

  • Choose for visual time selection: Use TimePicker when users benefit from a visual picker interface. Use TimeField when users know the exact time.
  • Use correct format: Always use HH:mm:ss format with leading zeros. The internal format is always 24-hour regardless of UI presentation.
  • Validate before setting values: Invalid values reset to empty string. Implement validation to show appropriate error messages.
Was this page helpful?