DatePickerComponent
Represents the Kendo UI DatePicker component for Angular.
Selector
kendo-datepicker
Export Name
Accessible in templates as #kendoDatePickerInstance="kendo-datepicker"
Inputs
activeView
Defines the active view that the Calendar initially renders
(see example).
By default, the active view is month
.
You have to set
activeView
within thetopView
-bottomView
range.
bottomView
Defines the bottommost Calendar view to which the user can navigate (see example).
disabled
boolean
Sets or gets the disabled
property of the DatePicker and determines whether the component is active
(see example).
disabledDatesValidation
boolean
Determines whether the built-in validator for disabled date ranges is enforced when validating a form (see example).
focusedDate
Date
Specifies the focused date of the Calendar component (see example).
format
string | FormatSettings
Specifies the date format that is used to display the input value (see example).
Format value options:
string
- Provide astring
if a single format is going to be used regardless whether the input is focused or blurred.FormatSettings
- To display different formats when the component is focused or blurred, provide a settings object with specifiedinputFormat
anddisplayFormat
values.
formatPlaceholder
Defines the descriptions of the format sections in the input field. (more information and examples).
@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-datepicker formatPlaceholder="wide"></kendo-datepicker>
</div>
<div class="col-xs-12 col-md-6 example-col">
<p>Narrow-length format description:</p>
<kendo-datepicker formatPlaceholder="narrow"></kendo-datepicker>
</div>
<div class="col-xs-12 col-md-6 example-col">
<p>Short-length format description:</p>
<kendo-datepicker formatPlaceholder="short"></kendo-datepicker>
</div>
<div class="col-xs-12 col-md-6 example-col">
<p>Display defined format:</p>
<kendo-datepicker format="MM/dd/yyyy" formatPlaceholder="formatPattern"></kendo-datepicker>
</div>
<div class="col-xs-12 col-md-6 example-col">
<p>Custom defined format descriptions</p>
<kendo-datepicker format="MM/dd/yyyy"
[formatPlaceholder]="{ year: 'y', month: 'M', day: 'd' }"
></kendo-datepicker>
</div>
</div>
`
})
export class AppComponent { }
incompleteDateValidation
boolean
Determines whether the built-in validation for incomplete dates is to be enforced when a form is being validated.
max
Date
Specifies the biggest valid date (see example).
min
Date
Specifies the smallest valid date (see example).
navigation
boolean
Sets or gets the navigation
property of the Calendar
and determines whether the navigation side-bar is displayed.
(see example).
placeholder
string
Specifies the hint the DatePicker displays when its value is null
.
(more information and exaples).
@Component({
selector: 'my-app',
template: `
<kendo-datepicker placeholder="Enter birth date..."></kendo-datepicker>
`
})
export class AppComponent { }
rangeValidation
boolean
Determines whether the built-in min or max validators are enforced when validating a form.
readOnlyInput
boolean
Sets the read-only state of the DatePicker input field (see example).
Note that if you set the
readonly
property value totrue
, the input will be rendered in a read-only state regardless of thereadOnlyInput
value.
readonly
boolean
Sets the read-only state of the DatePicker (see example).
tabindex
number
Sets or gets the tabindex
property of the DatePicker.
title
string
Sets the title of the input element of the DatePicker.
topView
Defines the topmost Calendar view to which the user can navigate (see example).
twoDigitYearMax
number
The maximum year to assume to be from the current century when typing two-digit year value (see example).
The default value is 68, indicating that typing any value less than 69 will be assumed to be 20xx, while 69 and larger will be assumed to be 19xx.
weekNumber
boolean
Determines whether to display a week number column in the month
view of the Calendar
(see example).
disabledDates
(date: Date) => boolean | Date[] | Day[]
Sets the dates of the DatePicker that will be disabled (see example).
popupSettings
Configures the popup options of the DatePicker.
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.
value
Date
Specifies the value of the DatePicker component.
The
value
has to be a valid JavaScriptDate
instance.
Fields
isOpen
boolean
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 (more information and example).
blur
EventEmitter<any>
Fires each time the input element gets blurred (more information and example).
To wire the event programmatically, use the
onBlur
property.
@Component({
selector: 'my-app',
template: `
<kendo-datepicker (blur)="handleBlur()"></kendo-datepicker>
`
})
export class AppComponent {
public handleBlur(): void {
console.log("Component is blurred");
}
}
focus
EventEmitter<any>
Fires each time the user focuses the input element (more information and example).
To wire the event programmatically, use the
onFocus
property.
@Component({
selector: 'my-app',
template: `
<kendo-datepicker (focus)="handleFocus()"></kendo-datepicker>
`
})
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 (more information and example).
valueChange
EventEmitter<Date>
Fires each time the user selects a new value (more information and example).
Methods
blur
Blurs the DatePicker component.
focus
Focuses the DatePicker component.
@Component({
selector: 'my-app',
template: `
<button (click)="datepicker.focus()">Focus date picker</button>
<kendo-datepicker #datepicker></kendo-datepicker>
`
})
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?
boolean
The state of the popup.