devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
520 lines (395 loc) • 21.2 kB
TypeScript
/*!
* devextreme-angular
* Version: 25.1.4
* Build date: Tue Aug 05 2025
*
* Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file in the root of the project for details.
*
* https://github.com/DevExpress/devextreme-angular
*/
import { TransferState, ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core';
import { DisabledDate, CalendarZoomLevel, DisposingEvent, InitializedEvent, OptionChangedEvent, ValueChangedEvent, CalendarSelectionMode, WeekNumberRule } from 'devextreme/ui/calendar';
import { FirstDayOfWeek, ValidationMessageMode, Position, ValidationStatus } from 'devextreme/common';
import DxCalendar from 'devextreme/ui/calendar';
import { ControlValueAccessor } from '@angular/forms';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import type * as DxCalendarTypes from "devextreme/ui/calendar_types";
import * as i0 from "@angular/core";
import * as i1 from "devextreme-angular/core";
/**
* The Calendar is a UI component that displays a calendar and allows an end user to select the required date within a specified date range.
*/
export declare class DxCalendarComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxCalendar;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
get accessKey(): string | undefined;
set accessKey(value: string | undefined);
/**
* Specifies whether the UI component changes its visual state as a result of user interaction.
*/
get activeStateEnabled(): boolean;
set activeStateEnabled(value: boolean);
/**
* Specifies a custom template for calendar cells.
*/
get cellTemplate(): any;
set cellTemplate(value: any);
/**
* Specifies the date-time value serialization format.
*/
get dateSerializationFormat(): string | undefined;
set dateSerializationFormat(value: string | undefined);
/**
* Specifies whether the UI component responds to user interaction.
*/
get disabled(): boolean;
set disabled(value: boolean);
/**
* Specifies dates that users cannot select.
*/
get disabledDates(): Array<Date> | ((data: DisabledDate) => boolean);
set disabledDates(value: Array<Date> | ((data: DisabledDate) => boolean));
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
get elementAttr(): Record<string, any>;
set elementAttr(value: Record<string, any>);
/**
* Specifies the first day of a week.
*/
get firstDayOfWeek(): FirstDayOfWeek | undefined;
set firstDayOfWeek(value: FirstDayOfWeek | undefined);
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
get focusStateEnabled(): boolean;
set focusStateEnabled(value: boolean);
/**
* Specifies the UI component's height.
*/
get height(): number | string | undefined;
set height(value: number | string | undefined);
/**
* Specifies text for a hint that appears when a user pauses on the UI component.
*/
get hint(): string | undefined;
set hint(value: string | undefined);
/**
* Specifies whether the UI component changes its state when a user pauses on it.
*/
get hoverStateEnabled(): boolean;
set hoverStateEnabled(value: boolean);
/**
* Specifies whether the component's current value differs from the initial value.
*/
get isDirty(): boolean;
set isDirty(value: boolean);
/**
* Specifies or indicates whether the editor's value is valid.
*/
get isValid(): boolean;
set isValid(value: boolean);
/**
* The latest date the UI component allows to select.
*/
get max(): Date | null | number | string;
set max(value: Date | null | number | string);
/**
* Specifies the maximum zoom level of the calendar.
*/
get maxZoomLevel(): CalendarZoomLevel;
set maxZoomLevel(value: CalendarZoomLevel);
/**
* The earliest date the UI component allows to select.
*/
get min(): Date | null | number | string;
set min(value: Date | null | number | string);
/**
* Specifies the minimum zoom level of the calendar.
*/
get minZoomLevel(): CalendarZoomLevel;
set minZoomLevel(value: CalendarZoomLevel);
/**
* The value to be assigned to the `name` attribute of the underlying HTML element.
*/
get name(): string;
set name(value: string);
/**
* Specifies whether the editor is read-only.
*/
get readOnly(): boolean;
set readOnly(value: boolean);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* Specifies one of three selection modes: single, multiple, or range.
*/
get selectionMode(): CalendarSelectionMode;
set selectionMode(value: CalendarSelectionMode);
/**
* Specifies whether a user can select a week by clicking on a week number.
*/
get selectWeekOnClick(): boolean;
set selectWeekOnClick(value: boolean);
/**
* Specifies whether or not the UI component displays a button that selects the current date.
*/
get showTodayButton(): boolean;
set showTodayButton(value: boolean);
/**
* Specifies whether to display a column with week numbers.
*/
get showWeekNumbers(): boolean;
set showWeekNumbers(value: boolean);
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
get tabIndex(): number;
set tabIndex(value: number);
/**
* Information on the broken validation rule. Contains the first item from the validationErrors array.
*/
get validationError(): any;
set validationError(value: any);
/**
* An array of validation errors.
*/
get validationErrors(): Array<any>;
set validationErrors(value: Array<any>);
/**
* Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
*/
get validationMessageMode(): ValidationMessageMode;
set validationMessageMode(value: ValidationMessageMode);
/**
* Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
*/
get validationMessagePosition(): Position;
set validationMessagePosition(value: Position);
/**
* Indicates or specifies the current validation status.
*/
get validationStatus(): ValidationStatus;
set validationStatus(value: ValidationStatus);
/**
* An object or a value that specifies the date and time selected in the calendar.
*/
get value(): Array<Date | null | number | string> | Date | null | number | string;
set value(value: Array<Date | null | number | string> | Date | null | number | string);
/**
* Specifies whether the UI component is visible.
*/
get visible(): boolean;
set visible(value: boolean);
/**
* Specifies a week number calculation rule.
*/
get weekNumberRule(): WeekNumberRule;
set weekNumberRule(value: WeekNumberRule);
/**
* Specifies the UI component's width.
*/
get width(): number | string | undefined;
set width(value: number | string | undefined);
/**
* Specifies the current calendar zoom level.
*/
get zoomLevel(): CalendarZoomLevel;
set zoomLevel(value: CalendarZoomLevel);
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: EventEmitter<DisposingEvent>;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized: EventEmitter<InitializedEvent>;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged: EventEmitter<OptionChangedEvent>;
/**
* A function that is executed after the UI component's value is changed.
*/
onValueChanged: EventEmitter<ValueChangedEvent>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
accessKeyChange: EventEmitter<string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
activeStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
cellTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dateSerializationFormatChange: EventEmitter<string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
disabledDatesChange: EventEmitter<Array<Date> | ((data: DisabledDate) => boolean)>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
elementAttrChange: EventEmitter<Record<string, any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
firstDayOfWeekChange: EventEmitter<FirstDayOfWeek | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
focusStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
heightChange: EventEmitter<number | string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hintChange: EventEmitter<string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hoverStateEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
isDirtyChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
isValidChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxChange: EventEmitter<Date | null | number | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxZoomLevelChange: EventEmitter<CalendarZoomLevel>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minChange: EventEmitter<Date | null | number | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minZoomLevelChange: EventEmitter<CalendarZoomLevel>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
nameChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
readOnlyChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
rtlEnabledChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
selectionModeChange: EventEmitter<CalendarSelectionMode>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
selectWeekOnClickChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showTodayButtonChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showWeekNumbersChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
tabIndexChange: EventEmitter<number>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationErrorsChange: EventEmitter<Array<any>>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationMessageModeChange: EventEmitter<ValidationMessageMode>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationMessagePositionChange: EventEmitter<Position>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
validationStatusChange: EventEmitter<ValidationStatus>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
valueChange: EventEmitter<Array<Date | null | number | string> | Date | null | number | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
visibleChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
weekNumberRuleChange: EventEmitter<WeekNumberRule>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
widthChange: EventEmitter<number | string | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
zoomLevelChange: EventEmitter<CalendarZoomLevel>;
/**
*
*/
onBlur: EventEmitter<any>;
change(_: any): void;
touched: (_: any) => void;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxCalendar;
writeValue(value: any): void;
setDisabledState(isDisabled: boolean): void;
registerOnChange(fn: (_: any) => void): void;
registerOnTouched(fn: () => void): void;
_createWidget(element: any): void;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
static ɵfac: i0.ɵɵFactoryDeclaration<DxCalendarComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxCalendarComponent, "dx-calendar", never, { "accessKey": { "alias": "accessKey"; "required": false; }; "activeStateEnabled": { "alias": "activeStateEnabled"; "required": false; }; "cellTemplate": { "alias": "cellTemplate"; "required": false; }; "dateSerializationFormat": { "alias": "dateSerializationFormat"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "disabledDates": { "alias": "disabledDates"; "required": false; }; "elementAttr": { "alias": "elementAttr"; "required": false; }; "firstDayOfWeek": { "alias": "firstDayOfWeek"; "required": false; }; "focusStateEnabled": { "alias": "focusStateEnabled"; "required": false; }; "height": { "alias": "height"; "required": false; }; "hint": { "alias": "hint"; "required": false; }; "hoverStateEnabled": { "alias": "hoverStateEnabled"; "required": false; }; "isDirty": { "alias": "isDirty"; "required": false; }; "isValid": { "alias": "isValid"; "required": false; }; "max": { "alias": "max"; "required": false; }; "maxZoomLevel": { "alias": "maxZoomLevel"; "required": false; }; "min": { "alias": "min"; "required": false; }; "minZoomLevel": { "alias": "minZoomLevel"; "required": false; }; "name": { "alias": "name"; "required": false; }; "readOnly": { "alias": "readOnly"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "selectionMode": { "alias": "selectionMode"; "required": false; }; "selectWeekOnClick": { "alias": "selectWeekOnClick"; "required": false; }; "showTodayButton": { "alias": "showTodayButton"; "required": false; }; "showWeekNumbers": { "alias": "showWeekNumbers"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "validationError": { "alias": "validationError"; "required": false; }; "validationErrors": { "alias": "validationErrors"; "required": false; }; "validationMessageMode": { "alias": "validationMessageMode"; "required": false; }; "validationMessagePosition": { "alias": "validationMessagePosition"; "required": false; }; "validationStatus": { "alias": "validationStatus"; "required": false; }; "value": { "alias": "value"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "weekNumberRule": { "alias": "weekNumberRule"; "required": false; }; "width": { "alias": "width"; "required": false; }; "zoomLevel": { "alias": "zoomLevel"; "required": false; }; }, { "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onValueChanged": "onValueChanged"; "accessKeyChange": "accessKeyChange"; "activeStateEnabledChange": "activeStateEnabledChange"; "cellTemplateChange": "cellTemplateChange"; "dateSerializationFormatChange": "dateSerializationFormatChange"; "disabledChange": "disabledChange"; "disabledDatesChange": "disabledDatesChange"; "elementAttrChange": "elementAttrChange"; "firstDayOfWeekChange": "firstDayOfWeekChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "isDirtyChange": "isDirtyChange"; "isValidChange": "isValidChange"; "maxChange": "maxChange"; "maxZoomLevelChange": "maxZoomLevelChange"; "minChange": "minChange"; "minZoomLevelChange": "minZoomLevelChange"; "nameChange": "nameChange"; "readOnlyChange": "readOnlyChange"; "rtlEnabledChange": "rtlEnabledChange"; "selectionModeChange": "selectionModeChange"; "selectWeekOnClickChange": "selectWeekOnClickChange"; "showTodayButtonChange": "showTodayButtonChange"; "showWeekNumbersChange": "showWeekNumbersChange"; "tabIndexChange": "tabIndexChange"; "validationErrorChange": "validationErrorChange"; "validationErrorsChange": "validationErrorsChange"; "validationMessageModeChange": "validationMessageModeChange"; "validationMessagePositionChange": "validationMessagePositionChange"; "validationStatusChange": "validationStatusChange"; "valueChange": "valueChange"; "visibleChange": "visibleChange"; "weekNumberRuleChange": "weekNumberRuleChange"; "widthChange": "widthChange"; "zoomLevelChange": "zoomLevelChange"; "onBlur": "onBlur"; }, never, never, true, never>;
}
export declare class DxCalendarModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxCalendarModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxCalendarModule, never, [typeof DxCalendarComponent, typeof i1.DxIntegrationModule, typeof i1.DxTemplateModule], [typeof DxCalendarComponent, typeof i1.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxCalendarModule>;
}
export { DxCalendarTypes };