TimePickerComponent

Represents the Kendo UI TimePicker component for Angular.

Selector

kendo-timepicker

Export Name

Accessible in templates as #kendoTimePickerInstance="kendo-timepicker"

Inputs

cancelButton

Determines whether to display the Cancel button in the popup.

disabled

Sets or gets the disabled property of the TimePicker and determines whether the component is active (see example).

format

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

formatPlaceholder

Defines the descriptions of the format sections in the input field. For more information, refer to the article on placeholders.

Copy Code@Component({
selector: 'my-app',
template: `
<div class="row example-wrapper" style="min-height: 450px;">
 <div class="col-xs-12 col-md-6 example-col">
   <p>Full-length format description:</p>
   <kendo-timepicker formatPlaceholder="wide"></kendo-timepicker>
 </div>

 <div class="col-xs-12 col-md-6 example-col">
   <p>Narrow-length format description:</p>
   <kendo-timepicker formatPlaceholder="narrow"></kendo-timepicker>
 </div>

 <div class="col-xs-12 col-md-6 example-col">
   <p>Short-length format description:</p>
   <kendo-timepicker formatPlaceholder="short"></kendo-timepicker>
 </div>

 <div class="col-xs-12 col-md-6 example-col">
   <p>Display defined format:</p>
   <kendo-timepicker format="HH:mm:ss" formatPlaceholder="formatPattern"></kendo-timepicker>
 </div>

 <div class="col-xs-12 col-md-6 example-col">
   <p>Custom defined format descriptions</p>
   <kendo-timepicker format="HH:mm:ss"
     [formatPlaceholder]="{ hour: 'H', minute: 'm', second: 's' }"
   ></kendo-timepicker>
 </div>
</div>
`
})
export class AppComponent { }

incompleteDateValidation

Determines whether the built-in validation for incomplete dates is to be enforced when a form is being validated.

nowButton

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.

placeholder

Specifies the hint the TimePicker displays when its value is null. For more information, refer to the article on placeholders.

Copy Code@Component({
selector: 'my-app',
template: `
 <kendo-timepicker placeholder="Enter start..."></kendo-timepicker>
`
})
export class AppComponent { }

rangeValidation

Determines whether the built-in min or max validators are enforced when a form is being validated.

readOnlyInput

Sets the read-only state of the TimePicker input field (see example).

Note that if you set the readonly property value to true, the input will be rendered in a read-only state regardless of the readOnlyInput value.

readonly

Sets the read-only state of the TimePicker (see example).

tabindex

Sets or gets the tabindex property of the TimePicker.

title

Sets the title of the input element of the TimePicker.

max

Specifies the biggest valid time value (see example).

min

Specifies the smallest valid time value (see example).

popupSettings

Configures the popup of the TimePicker.

The available options are:

• animate: Boolean—Controls the popup animation. By default, the open and close animations are enabled.
• appendTo: 'root' | 'component' | ViewContainerRef—Controls the popup container. By default, the popup will be appended to the root component.
• popupClass: String—Specifies a list of CSS classes that are used to style the popup.

steps

Configures the incremental steps of the TimePicker. For more information, refer to the article on incremental steps.

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

Copy Code@Component({
selector: 'my-app',
template: `
 <kendo-timepicker format="HH:mm:ss" [steps]="steps"></kendo-timepicker>
`
})
class AppComponent {
  public steps = { hour: 2, minute: 15, second: 15, millisecond: 10 };
}

value

Specifies the value of the TimePicker component.

Fields

isOpen

Returns the current open state of the popup.

Events

close

Fires each time the popup is about to close. This event is preventable. If you cancel the event, the popup will remain open. For more information, refer to the section on events.

blur

Fires each time the input element gets blurred. For more information, refer to the section on events.

To wire the event programmatically, use the onBlur property.

Copy Code@Component({
selector: 'my-app',
template: `
 <kendo-timepicker (blur)="handleBlur()"></kendo-timepicker>
`
})
export class AppComponent {
  public handleBlur(): void {
     console.log("Component is blurred");
  }
}

focus

Fires each time the user focuses the input element. For more information, refer to the section on events.

To wire the event programmatically, use the onFocus property.

Copy Code@Component({
selector: 'my-app',
template: `
 <kendo-timepicker (focus)="handleFocus()"></kendo-timepicker>
`
})
export class AppComponent {
  public handleFocus(): void {
     console.log("Component is focused");
  }
}

open

Fires each time the popup is about to open. This event is preventable. If you cancel the event, the popup will remain closed. For more information, refer to the section on events.

valueChange

Fires each time the user selects a new value. For more information, refer to the section on events.

Methods

blur

Blurs the TimePicker component.

focus

Focuses the TimePicker component.

Copy Code@Component({
selector: 'my-app',
template: `
 <button (click)="timepicker.focus()">Focus time picker</button>
 <kendo-timepicker #timepicker></kendo-timepicker>
`
})
export class AppComponent { }

toggle

Toggles the visibility of the popup. If you use the toggle method to show or hide the popup, the open and close events do not fire.

Parameters

show?

The state of the popup.