Property | Type | Required | Default | Description |
---|---|---|---|---|
ariaLabels | { ampm: string; hours: string; minutes: string; clear: string; timeDown: string; timeUp: string; } | false | { ampm: 'Select time of day (AM/PM) using up (PM) and down (AM) arrow keys', clear: 'Delete the entered time', hours: 'Enter the hour in 00:00 format', minutes: 'Enter the minutes in 00:00 format', timeDown: 'Time down', timeUp: 'Time up', } | Add the labels for the input elements and the input clear button, use this to provide accessibility and internationalization. By default the text is in English. |
config | { use12Hours: Config; use24Hours: Config; } | false | { use12Hours: { ampm: { am: 'AM', pm: 'PM', }, hours: { max: 12, min: 1, }, minutes: { max: 59, min: 0, }, }, use24Hours: { ampm: { am: 'AM', pm: 'PM', }, hours: { max: 23, min: 0, }, minutes: { max: 59, min: 0, }, }, } | Range settings for 12 or 24 hours. |
disabled | boolean | false | false | Flag to disable user interactions on the component. |
icon | boolean | false | false | Flag to indicate if show time icon or not. |
onInputChange | (values: Input) => void | false | () => {} | Called when input values change hour, minutes or ampm. |
name | string | false | Name attribute for the hidden input (used for form submission). | |
values | { ampm?: InputAmPm; hours: '--' | string; minutes: '--' | string; } | false | { hours: DEFAULT_VALUE, minutes: DEFAULT_VALUE, } | Sets the values for the hour, minute, or am/pm input. |
spritemap | string | false | The path to the SVG spritemap file containing the icons. | |
timezone | string | false | Flag to indicate the timezone of the user. | |
use12Hours | boolean | false | false | Flag to indicate if 12-hour use, when true, should show am/pm input. |