TimePickerProps
Represents the props of the Kendo UI for Vue TimePicker component.
Definition
Package:@progress/kendo-vue-dateinputs
Properties
ariaDescribedBy?
string
Sets the id values of the elements that describe the TimePicker, similar to the HTML aria-describedby attribute.
For example, these elements can contain an error or a hint message.
ariaLabelledBy?
string
Sets the id values of the elements that label the TimePicker.
cancelButton?
boolean
When you set it to true, the popup shows the Cancel button.
true
dateInput?
any
Lets you customize or replace the default DateInput of the TimePicker (see example).
defaultShow?
boolean
Sets whether the popup is open on the first render (see example).
false
defaultValue?
Date
Sets the initial value of the TimePicker when you do not set value (see example).
null
disabled?
boolean
When you set it to true, the TimePicker is disabled (see example).
false
fillMode?
string
Configures the fillMode of the TimePicker.
The available options are:
- solid
- outline
- flat
- link
- null—Does not set a fillMode
class.
solid
format?
string | DateFormatOptions
Sets the date format that the TimePicker uses to show the input value (see example).
't'
Sets the descriptions of the format sections in the input field (see example).
id?
string
Sets the id of the input element of the TimePicker. The floating label uses it to point to the input.
inputAttributes?
Object
Sets the built-in HTML attributes of the inner focusable input element.
You cannot change the attributes that the component needs to work.
label?
string
Renders a floating label for the TimePicker.
max?
Date
Sets the latest valid time (see example).
min?
Date
Sets the earliest valid time (see example).
name?
string
Sets the name property of the input DOM element.
nowButton?
boolean
When you set it to true, the popup shows the Now button.
If the current time is out of range or the incremental step is greater than
1, the TimePicker hides the Now button.
onBlur?
(event: any) => void
Fires each time any element of the TimePicker loses focus. The event name is blur.
onChange?
(event: TimePickerChangeEvent) => void
Fires each time the user selects a new value. The event name is change (see example).
onFocus?
(event: any) => void
Fires each time the user focuses any element of the TimePicker. The event name is focus.
onIconclick?
(event: any) => void
Fires when the user clicks the clock icon. The event name is iconclick.
placeholder?
string
Sets the placeholder text of the TimePicker.
popup?
any
Lets you customize or replace the default Popup of the TimePicker (see example).
Configures the popup options of the TimePicker.
The available options are:
animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled.appendTo:— Sets the container to which the Popup is appended. Defaults tobody.popupClass: String—Sets a list of CSS classes that style the popup.
{}
required?
boolean
Sets whether null is a valid value for the component.
rounded?
string
Configures the roundness of the TimePicker.
The available options are:
- small
- medium
- large
- circle
- full
- null—Does not set a rounded
class.
medium
show?
boolean
Sets whether the TimePicker shows the time selector (see example).
size?
"small" | "medium" | "large"
Configures the size of the TimePicker.
The available options are:
- small
- medium
- large
- null—Does not set a size
class.
medium
smoothScroll?
boolean
Turns the smooth scroll animation on or off when the user clicks a time. By default, the animation is on.
true
Configures the incremental steps of the TimePicker (see example).
If the incremental step is greater than
1, the TimePicker hides the Now button.
{}
tabIndex?
number
Sets the tabIndex property of the TimePicker.
0
title?
string
Sets the title of the input element of the TimePicker.
''
valid?
boolean
Overrides the validity state of the component.
When you set valid, the component ignores the required property.
validate?
boolean
Sets whether the TimePicker validates its value.
validationMessage?
string
Sets the form error message of the component. If you set it to an empty string, the component shows no error.
validityStyles?
boolean
Shows or hides the invalid state styles of the component. When you set it to false, the component shows no invalid state styles.
value?
Date
Sets the value of the TimePicker (see example).
The
valuemust be a valid JavaScriptDateinstance.
width?
string | number
Sets the width of the TimePicker.