Time
The 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 .
Anchor to propertiesProperties
Configure the following properties on the component.
- string
A unique identifier for the element used for targeting with CSS, JavaScript, or accessibility features.
- Anchor to valuevaluestringDefault: ''
The current selected value in 24-hour format. An empty string means no time is selected. The value must be in
format with leading zeros (for example,"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.
Anchor to eventsEvents
The component provides event callbacks for handling user interactions. Learn more about handling events.
- Anchor to blurblur(event: CallbackEvent<"s-time-picker">) => void
Called when the element loses focus.
- Anchor to changechange(event: CallbackEvent<"s-time-picker">) => void
Called after editing completes, typically on blur.
- Anchor to focusfocus(event: CallbackEvent<"s-time-picker">) => void
Called when the element receives focus.
- Anchor to inputinput(event: CallbackEvent<"s-time-picker">) => void
Called when the user makes any changes in the field.
CallbackEvent
Represents the event object passed to callback functions when interactive events occur. Contains metadata about the event, including the target element, event phase, and propagation behavior.
- bubbles
Whether the event bubbles up through the DOM tree.
boolean - cancelable
Whether the event can be canceled.
boolean - composed
Whether the event will trigger listeners outside of a shadow root.
boolean - currentTarget
The element that the event listener is attached to.
HTMLElementTagNameMap[T] - detail
Additional data associated with the event.
any - eventPhase
The current phase of the event flow.
number - target
The element that triggered the event.
HTMLElementTagNameMap[T] | null
interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
/**
* The element that the event listener is attached to.
*/
currentTarget: HTMLElementTagNameMap[T];
/**
* Whether the event bubbles up through the DOM tree.
*/
bubbles?: boolean;
/**
* Whether the event can be canceled.
*/
cancelable?: boolean;
/**
* Whether the event will trigger listeners outside of a shadow root.
*/
composed?: boolean;
/**
* Additional data associated with the event.
*/
detail?: any;
/**
* The current phase of the event flow.
*/
eventPhase: number;
/**
* The element that triggered the event.
*/
target: HTMLElementTagNameMap[T] | null;
}Select times with a time picker
Examples
Select times with a time picker
Description
Select times using a `TimePicker` component. This example shows a basic time picker for selecting hours and minutes.
Default
<s-button command="--show" commandFor="time-picker"> Show </s-button> <s-time-picker value="9:41" id="time-picker" />
Preview
Anchor to best-practicesBest practices
- Choose for visual time selection: Use
when users benefit from a visual picker interface. Usewhen users know the exact time. - Use correct format: Always use
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.
Anchor to examplesExamples
Learn how to control picker visibility and handle time selection events.
Anchor to example-control-picker-visibilityControl picker visibility
Control 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.
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 events to capture selected times, enabling validation, scheduling logic, or dynamic updates based on the chosen time.
Control picker visibility
Examples
Control picker visibility
Description
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.
Default
<> <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)} /> </>;Handle time selection events
Description
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.
Default
<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')} />