TimePickerProps

Represents the props of the KendoReact TimePicker component.

cancelButton? boolean

Determines whether to display the Cancel button in the popup.

className? string

Sets the className of the TimePicker.

dateInput? React.ComponentType<DateInputProps>

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

defaultShow? boolean

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

defaultValue? Date

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

disabled? boolean

Determines whether the TimePicker is disabled (see example).

format? string

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

formatPlaceholder? DateInputFormatPlaceholder

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

id? string

Specifies the id of 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: FocusEvent<HTMLDivElement>) => void

Fires each time any of the TimePicker elements gets blurred.

onChange? (event: TimePickerChangeEvent) => void

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

onFocus? (event: FocusEvent<undefined>) => void

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

popup? React.ComponentType<PopupProps>

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

popupSettings? DateInputsPopupSettings

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.

This property is part of the FormComponentProps interface.

show? boolean

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

smoothScroll? boolean

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

steps? TimePickerIncrementalSteps

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.

This property is part of the FormComponentProps interface.

validationMessage? string

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

This property is part of the FormComponentProps interface.

validityStyles? boolean

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

This property is part of the FormComponentProps interface.

value? Date | null

Specifies the value of the TimePicker (see example).

The value has to be a valid JavaScript Date instance.

width? number | string

Specifies the width of the TimePicker.

 /