@spartanfx/react v1.2.2
@spartanfx/react / index / ITimePickerProps
Interface: ITimePickerProps
Props for the embedded TimePicker sub-component.
Properties
Required
| Property | Type | Default | Description |
|---|
hours | number | - | Current hour value (0-23 in 24h format, 1-12 in 12h format). |
minutes | number | - | Current minute value (0-59). |
onChange | (next) => void | - | Called whenever the user changes the hours, minutes or AM/PM marker. |
Options
| Property | Type | Default | Description |
|---|
disabled? | boolean | - | Disables the whole picker (fields are rendered but not editable). |
format? | TimeFormat | TimeFormat.H24 | Time format used to render and validate the inputs. |
label? | string | 'Time' | Optional label displayed above the fields (e.g. localized "Time"). |
minuteStep? | number | 1 | Step (in minutes) applied when using the up/down arrows on the minutes field or when scrolling with keyboard shortcuts. |
period? | "AM" | "PM" | - | AM/PM marker when the format is H12. Ignored in 24h mode. |
Events & callbacks
| Property | Type | Default | Description |
|---|
translate? | (text) => string | - | Optional translate function applied to built-in strings. |
Appearance & theming
| Property | Type | Default | Description |
|---|
appearanceMode? | AppearanceMode | AppearanceMode.light | Visual theme (follows the global AppearanceMode). |
tokens? | IDateTimePickerTokens | - | Optional tokens that override the default palette / sizing. |