New to Kendo UI for VueStart a free 30-day trial

Represents the props of the Kendo UI for Vue TimePicker component.

Definition

Package:@progress/kendo-vue-dateinputs

Properties

Identifies the element(s) which will describe the component, similar to HTML aria-describedby attribute. For example these elements could contain error or hint message.

Identifies the element(s) which will label the component.

Determines whether to display the Cancel button in the popup.

Enables the customization or the override of the default DateInput which is rendered by the TimePicker (see example).

Sets the default state of the popup upon render (see example).

Sets the default value of the TimePicker (see example).

disabled?

boolean

Determines whether the TimePicker is disabled (see example).

fillMode?

string

Configures the fillMode of the TimeInput.

The available options are:

  • solid
  • outline
  • flat
  • link
  • null—Does not set a fillMode class.
Default:

solid

format?

string | DateFormatOptions

Specifies the date format that is used to display the input value (see example).

Defines the descriptions of the format sections in the input field (see example).

id?

string

Specifies the id of the TimePicker.

Sets the built-in HTML attributes of the inner focusable input element. Attributes which are essential for certain component functionalities cannot be changed.

label?

string

Renders a floating label for the TimePicker.

max?

Date

Specifies the greatest valid time (see example).

min?

Date

Specifies the smallest valid time (see example).

name?

string

Specifies the name property of the input DOM element.

nowButton?

boolean

Determines whether to display the Now button in the popup.

If the current time is out of range or the incremental step is greater than 1, the Now button will be hidden.

onBlur?

(event: any) => void

Fires each time any of the TimePicker elements gets blurred.

Parameters:eventany

Fires each time the user selects a new value (see example).

Parameters:eventTimePickerChangeEvent

onFocus?

(event: any) => void

Fires each time the user focuses any of the TimePicker elements.

Parameters:eventany

onIconclick?

(event: any) => void

Fires when the icon element is clicked.

Parameters:eventany

Specifies the value of the placeholder.

Enables the customization or the override of the default Popup which is rendered by 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:— Defines the container to which the Popup will be appended. Defaults to body.
  • popupClass: String—Specifies a list of CSS classes that are used to style the popup.

required?

boolean

Specifies if null is a valid value for the component.

rounded?

string

Configures the roundness of the TimeInput.

The available options are:

  • small
  • medium
  • large
  • circle
  • full
  • null—Does not set a rounded class.
Default:

medium

show?

boolean

Specifies if a time selector will be displayed (see example).

size?

"small" | "medium" | "large"

Configures the size of the TimeInput.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size class.
Default:

medium

Toggles the smooth scroll animation on time click. By default, the animation is enabled.

Configures the incremental steps of the TimePicker (see example).

If the incremental step is greater than 1, the Now button will be hidden.

tabIndex?

number

Sets the tabIndex property of the TimePicker.

title?

string

Sets the title of the input element of the TimePicker.

valid?

boolean

Overrides the validity state of the component. If valid is set, the required property will be ignored.

validate?

boolean

Specifies the validate of the TimePicker.

Controls the form error message of the component. If set to an empty string, no error will be thrown.

If set to false, no visual representation of the invalid state of the component will be applied.

value?

Date

Specifies the value of the TimePicker (see example).

The value has to be a valid JavaScript Date instance.

width?

string | number

Specifies the width of the TimePicker.