Skip to main content
Version: 1.1.0

ITimePickerProps

@spartanfx/react v1.1.0


@spartanfx/react / index / ITimePickerProps

Interface: ITimePickerProps

Props for the embedded TimePicker sub-component.

Properties

PropertyTypeDescription
appearanceMode?AppearanceModeVisual theme (follows the global AppearanceMode). Default AppearanceMode.light
disabled?booleanDisables the whole picker (fields are rendered but not editable).
format?TimeFormatTime format used to render and validate the inputs. Default TimeFormat.H24
hoursnumberCurrent hour value (0-23 in 24h format, 1-12 in 12h format).
label?stringOptional label displayed above the fields (e.g. localized "Time"). Default 'Time'
minutesnumberCurrent minute value (0-59).
minuteStep?numberStep (in minutes) applied when using the up/down arrows on the minutes field or when scrolling with keyboard shortcuts. Default 1
onChange(next) => voidCalled whenever the user changes the hours, minutes or AM/PM marker.
period?"AM" | "PM"AM/PM marker when the format is H12. Ignored in 24h mode.
tokens?IDateTimePickerTokensOptional tokens that override the default palette / sizing.
translate?(text) => stringOptional translate function applied to built-in strings.