Angular Calendar Properties

Default Value: true

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components. See the following GitHub repository for an example of this type of platform: MUI.

cellTemplate

Specifies a custom template for calendar cells.

Type:

template

Template Data:

Name	Type	Description
date	Date	A Date object associated with the cell.
text	String	The cell's text.
view	String	The current view's name.

Name

Type

Description

date

A Date object associated with the cell.

text

The cell's text.

view

The current view's name.

Default Name: 'cell'

dateSerializationFormat

Specifies the date-time value serialization format. Use it only if you do not specify the value at design time.

Type:

Default Value: undefined

Without a value, the UI component cannot detect its format. In this case, specify the dateSerializationFormat property that supports the following formats:

"yyyy-MM-dd" - a local date
"yyyy-MM-ddTHH:mm:ss" - local date and time
"yyyy-MM-ddTHH:mm:ssZ" - the UTC date and time
"yyyy-MM-ddTHH:mm:ssx" - date and time with a timezone

This property applies only if the forceIsoDateParsing field is set to true in the global configuration object.

NOTE

If you are going to change the value using the API, make sure that it has the same format that you specified in this property.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Default Value: false

disabledDates

Specifies dates that users cannot select.

Type:

Array<Date>

|

Function parameters:

data:

Information about the checked date.

Object structure:

Name	Type	Description
component	Object	The UI component's instance.
date	Date	The currently checked date.
view	String	The current view.

Name

Type

Description

component

The UI component's instance.

date

The currently checked date.

view

The current view.

Return Value:

true if the date should be disabled; otherwise false.

Default Value: null

This property accepts an array of dates:

jQuery

index.js

$(function() {
    $("#calendarContainer").dxCalendar({
        // ...
        disabledDates: [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ]
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-calendar ...
    [disabledDates]="disabledDates">
</dx-calendar>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disabledDates: Date[] = [ 
        new Date("07/1/2017"),  
        new Date("07/2/2017"), 
        new Date("07/3/2017") 
    ];
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxCalendarModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxCalendarModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxCalendar ...
        :disabled-dates="disabledDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxCalendar from 'devextreme-vue/calendar';

export default {
    components: {
        DxCalendar
    },
    data() {
        return {
            disabledDates: [ 
                new Date("07/1/2017"),  
                new Date("07/2/2017"), 
                new Date("07/3/2017") 
            ]
        }
    }
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Calendar from 'devextreme-react/calendar';

class App extends React.Component {
    constructor() {
        this.disabledDates = [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ];
    }
    render() {
        return (
            <Calendar ...
                disabledDates={this.disabledDates} 
            />
        );
    }
}
export default App;

Alternatively, pass a function to disabledDates. This function should define the rules that determine whether the checked date is disabled. A separate set of rules should target every view individually.

jQuery

index.js

$(function() {
    $("#calendarContainer").dxCalendar({
        // ...
        disabledDates: function(args) {
            const dayOfWeek = args.date.getDay();
            const month = args.date.getMonth();
            const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
            const isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-calendar ...
    [disabledDates]="disableDates">
</dx-calendar>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disableDates(args) {
        const dayOfWeek = args.date.getDay();
        const month = args.date.getMonth();
        const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
        const isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxCalendarModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxCalendarModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

Vue

App.vue

<template>
    <DxCalendar ...
        :disabled-dates="disableDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxCalendar from 'devextreme-vue/calendar';

export default {
    components: {
        DxCalendar
    },
    methods: {
        disableDates(args) {
            const dayOfWeek = args.date.getDay();
            const month = args.date.getMonth();
            const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
            const isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    }
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import Calendar from 'devextreme-react/calendar';

class App extends React.Component {
    disableDates(args) {
        const dayOfWeek = args.date.getDay();
        const month = args.date.getMonth();
        const isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 );
        const isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
    render() {
        return (
            <Calendar ...
                disabledDates={this.disableDates} 
            />
        );
    }
}
export default App;

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type: any

Default Value: {}

jQuery

$(function(){
    $("#calendarContainer").dxCalendar({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-calendar ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-calendar>

import { DxCalendarModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxCalendarModule
    ],
    // ...
})

Vue

App.vue

<template>
    <DxCalendar ...
        :element-attr="calendarAttributes">
    </DxCalendar>
</template>

<script>
import DxCalendar from 'devextreme-vue/calendar';

export default {
    components: {
        DxCalendar
    },
    data() {
        return {
            calendarAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

React

App.js

import React from 'react';

import Calendar from 'devextreme-react/calendar';

class App extends React.Component {
    calendarAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Calendar ...
                elementAttr={this.calendarAttributes}>
            </Calendar>
        );
    }
}
export default App;

firstDayOfWeek

Specifies the first day of a week.

Type:

Default Value: undefined

Accepted Values: 0 | 1 | 2 | 3 | 4 | 5 | 6

The property can take on a value from 0 to 6.

0 - Sunday
1 - Monday
2 - Tuesday
3 - Wednesday
4 - Thursday
5 - Friday
6 - Saturday

By default, the value provided by the culture settings is used.

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Default Value: true (desktop)

height

Specifies the UI component's height.

Type:

|

|

Return Value:

|

The UI component's height.

Default Value: undefined

This property accepts a value of one of the following types:

Number
The height in pixels.
String
A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

NOTE

The UI component's minimum height depends on the current theme. If the height property value is less than the minimum height, the UI component height is set to the minimum value, ignoring the specified value. Below is a list of minimum calendar sizes depending on the current theme.

Generic - 280x270
Android - 290x260
iOS - 260x260

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Default Value: true

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Default Value: true

NOTE

When you use async rules, isValid is true if the status is "pending" or "valid".

max

The latest date the UI component allows to select.

Type:

|

|

Default Value: new Date(3000, 0)

maxZoomLevel

Specifies the maximum zoom level of the calendar.

Type:

Default Value: 'month'

Accepted Values: 'century' | 'decade' | 'month' | 'year'

min

The earliest date the UI component allows to select.

Type:

|

|

Default Value: new Date(1000, 0)

minZoomLevel

Specifies the minimum zoom level of the calendar.

Type:

Default Value: 'century'

Accepted Values: 'century' | 'decade' | 'month' | 'year'

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

Default Value: ''

Specify this property if the UI component lies within an HTML form that will be submitted.

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Calendar

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

any

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Calendar

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	any	Model data. Available only if you use Knockout.
fullName	String	The path to the modified property that includes all parent properties.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Calendar	The UI component's instance.
name	String	The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.
value	any	The modified property's new value.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery

index.js

$(function() {
    $("#calendarContainer").dxCalendar({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<dx-calendar ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-calendar>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxCalendarModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxCalendarModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }

Vue

App.vue

<template> 
    <DxCalendar ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxCalendar from 'devextreme-vue/calendar'; 

export default { 
    components: { 
        DxCalendar
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script>

React

App.js

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Calendar from 'devextreme-react/calendar'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Calendar ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
}

onValueChanged

A function that is executed after the UI component's value is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Calendar	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
event	Event (jQuery or EventObject)	The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically.
model	any	Model data. Available only if Knockout is used.
previousValue	Object	The UI component's previous value.
value	Object	The UI component's new value.

Default Value: null

readOnly

Specifies whether the editor is read-only.

Type:

Default Value: false

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

showTodayButton

Specifies whether or not the UI component displays a button that selects the current date.

Type:

Default Value: false

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type: any

Default Value: null

validationErrors

An array of the validation rules that failed.

Type:

Array<any>

Default Value: null

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

Default Value: 'auto'

Accepted Values: 'always' | 'auto'

The following property values are possible:

auto
The tooltip with the message is displayed when the editor is in focus.
always
The tooltip with the message is not hidden when the editor loses focus.

validationStatus

Indicates or specifies the current validation status.

Type:

Default Value: 'valid'

Accepted Values: 'valid' | 'invalid' | 'pending'

The following table illustrates the validation status indicators:

validationStatus	Indicator
`"pending"`
`"valid"`
`"invalid"`

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

jQuery

index.js

$(function() {
    const calendar = $("#calendarContainer").dxCalendar({
        // ...
    }).dxCalendar("instance");

    function setInvalidStatus(message) {
        calendar.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

Angular

app.component.html

app.component.ts

<dx-calendar
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-calendar>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

Vue

App.vue

<template>
    <DxCalendar ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

React

App.js

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <Calendar
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

value

An object or a value specifying the date and time currently selected in the calendar.

Type:

|

|

Default Value: null

Raised Events: onValueChanged

You can specify the current UI component value using any of the following formats.

Date
Specifies the date directly.
Number
Specifies the date using a timestamp (total milliseconds since 1970/01/01).
String
Specifies the date using a string value. The UI component supports the following formats of a date string.
- "yyyy-MM-dd" (for example, "2017-03-06")
- "yyyy-MM-ddTHH:mm:ss" (for example, "2017-03-27T16:54:48")
- "yyyy-MM-ddTHH:mm:ssZ" (for example, "2017-03-27T13:55:41Z")
- "yyyy-MM-ddTHH:mm:ssx" (for example, "2017-03-27T16:54:10+03")

If the UI component value is changed by an end-user, the new value is saved in the same format as the initial value.

visible

Specifies whether the UI component is visible.

Type:

Default Value: true

width

Specifies the UI component's width.

Type:

|

|

Return Value:

|

The UI component's width.

Default Value: undefined

This property accepts a value of one of the following types:

Number
The width in pixels.
String
A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".
Function
A function returning either of the above. For example:
JavaScript
```
width: function() {
    return window.innerWidth / 1.5;
}
```

NOTE

The UI component has a minimum width that depends on the current theme. If the width property value is less than the minimum width, the UI component width is set to the minimum value, ignoring the specified value. Below is a list of minimum calendar sizes depending on the current theme.

Generic - 280x270
Android - 290x260
iOS - 260x260

zoomLevel

Specifies the current calendar zoom level.

Type:

Default Value: 'month'

Accepted Values: 'century' | 'decade' | 'month' | 'year'

Raised Events: onOptionChanged

Zoom level determines the size of a date range displayed on a single calendar page.