JavaScript/jQuery Calendar Options
See Also
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
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.
cellTemplate
If a cell is a week number, the date
field value is undefined
.
See Also
dateSerializationFormat
Specifies the date-time value serialization format. Use it only if you do not specify the value at design time.
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"
,"yyyy-MM-ddTHH:mm:ssxx"
,"yyyy-MM-ddTHH:mm:ssxxx"
- date and time with a timezone
This property applies only if the forceIsoDateParsing field is set to true in the global configuration object.
See Also
disabledDates
This property accepts an array of dates:
jQuery
$(function() { $("#calendarContainer").dxCalendar({ // ... disabledDates: [ new Date("07/1/2017"), new Date("07/2/2017"), new Date("07/3/2017") ] }); });
Angular
<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
<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
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
$(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
<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
<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
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;
See Also
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#calendarContainer").dxCalendar({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-calendar ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-calendar>
import { DxCalendarModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxCalendarModule ], // ... })
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
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;
height
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"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
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
isValid
See Also
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
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. |
onInitialized
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
See Also
jQuery
Angular
Vue
React
onOptionChanged
Name | Type | Description |
---|---|---|
model | any |
Model data. Available only if you use Knockout. |
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
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. |
previousValue | any |
The UI component's previous value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#calendarContainer").dxCalendar({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<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
<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
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.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
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 |
The UI component's previous value. |
|
value |
The UI component's new value. |
rtlEnabled
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.
DevExpress.config({ rtlEnabled: true });
tabIndex
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.
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
validationMessagePosition
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.
The following example positions a validation message at the component's right:
jQuery
$(function() { $("#calendarContainer").dxCalendar({ // ... validationMessagePosition: 'right' }).dxValidator({ validationRules: [{ type: 'required', message: 'Required', }], }); });
Angular
<dx-calendar ... validationMessagePosition="right"> <dx-validator> <dxi-validation-rule type="required" message="Required" > </dxi-validation-rule> </dx-validator> </dx-calendar>
Vue
<template> <DxCalendar ... validation-message-position="right" > <DxValidator> <DxRequiredRule message="Required" /> </DxValidator> </DxCalendar> </template> <script> // ... </script>
React
import React from 'react'; // ... function App() { return ( <Calendar ... validationMessagePosition="right" > <Validator> <RequiredRule message="Required" /> </Validator> </Calendar> ); }; export default App;
validationStatus
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
$(function() { const calendar = $("#calendarContainer").dxCalendar({ // ... }).dxCalendar("instance"); function setInvalidStatus(message) { calendar.option({ validationStatus: "invalid", validationErrors: [{ message: message }] }); } });
Angular
<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
<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
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
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.
weekNumberRule
Specifies a week number calculation rule.
This property can take on one of the following values:
firstDay
The first week of a year is the week that contains January 1.firstFourDays
The first week of a year is the week that starts on one of the first four weekdays: Monday, Tuesday, Wednesday, or Thursday. This rule is defined by the ISO 8601 standard. If the first week of the year begins on a Friday, Saturday, or Sunday, this week is considered the last week of the previous year.fullWeek
The first week of a year is the week that begins with a day that matches the firstDayOfWeek option value.auto
(default)
The week calculation rule depends on the locale. If a week starts on Monday, thefirstFourDays
rule is applied. Otherwise, thefirstDay
rule is in effect.
If you want to implement your own week number calculation rule, use the cellTemplate function:
jQuery
$(function() { let lastDateOfWeek; function getWeekNumber(date, firstDayOfWeek) { // Implement your own week calculation logic } function getCellTemplate(data) { if (data.view === 'month') { if (!data.date) { cssClass = 'week-number'; data.text = getWeekNumber(lastDateOfWeek, 0).toString(); } else { lastDateOfWeek = data.date; } } return `<span>${data.text}</span>`; } $('#calendar-container').dxCalendar({ value: new Date(2000, 0, 1), showWeekNumbers: true, cellTemplate: getCellTemplate }); });
Angular
<dx-calendar [value]="currentValue" [showWeekNumbers]="true" (cellTemplate)="custom" > <span *dxTemplate="let cell of 'custom'" [ngClass]="getCellCssClass(cell)" > {{ cell.text }} </span> </dx-calendar>
// ... export class AppComponent { lastDateOfWeek: Number; currentValue: Date = new Date(2000, 0, 1); getWeekNumber(date, firstDayOfWeek) { // Implement your own week calculation logic } getCellCssClass({ date, view, text }) { let cssClass = ''; if (view === 'month') { if (!date) { cssClass = 'week-number'; text = getWeekNumber(this.lastDateOfWeek, 0).toString(); } else { this.lastDateOfWeek = date; } } return cssClass; } }
Vue
<template> <DxCalendar :value="currentValue" :show-week-numbers="true" cell-template="custom" > <template #custom="{ data: cell }"> <span :class="getCellCssClass(cell)"> {{ cell.text }} </span> </template> </DxCalendar> </template> <script> // ... function getWeekNumber(date, firstDayOfWeek) { // Implement your own week calculation logic } export default { // ... data() { return { currentValue: new Date(2000, 0, 1), lastDateOfWeek: 0 } } methods: { getCellCssClass({ date, view, text }) { let cssClass = ''; if (view === 'month') { if (!date) { cssClass = 'week-number'; text = getWeekNumber(this.lastDateOfWeek, 0).toString(); } else { this.lastDateOfWeek = date; } } return cssClass; } } } </script>
React
// ... let lastDateOfWeek; const currentValue = new Date(2000, 0, 1); const getWeekNumber(date, firstDayOfWeek) { // Implement your own week calculation logic } const getCellCssClass({ date, view, text }) { let cssClass = ''; if (view === 'month') { if (!date) { cssClass = 'week-number'; text = getWeekNumber(lastDateOfWeek, 0).toString(); } else { lastDateOfWeek = date; } } return cssClass; } const customCell = (cell) => { const { text, } = cell; const className = getCellCssClass(cell); return ( <span className={className}> { text } </span> ); } function App() { return ( <Calendar value={currentValue} showWeekNumbers={true} cellRender={customCell} > </Calendar> ); }; export default App;
width
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"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
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
If you have technical questions, please create a support ticket in the DevExpress Support Center.