React Calendar Props
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
cellComponent
An alias for the cellTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
cellRender
An alias for the cellTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
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"
- date and time with a timezone
This property applies only if the forceIsoDateParsing field is set to true in the global configuration object.
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.common.css'; 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.common.css'; 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.common.css'; 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.common.css'; 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;
firstDayOfWeek
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.
Use the FirstDayOfWeek
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Sunday
, Monday
, Tuesday
, Wednesday
, Thursday
, Friday
, and Saturday
.
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"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
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
maxZoomLevel
Specifies the maximum zoom level of the calendar.
Use the CalendarZoomLevel
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month
, Year
, Decade
, and Century
.
See Also
minZoomLevel
Specifies the minimum zoom level of the calendar.
Use the CalendarZoomLevel
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month
, Year
, Decade
, and Century
.
See Also
name
Specify this property if the UI component lies within an HTML form that will be submitted.
If you configure the UI component as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this property to bind the UI component to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.
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 |
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. |
onOptionChanged
Name | Type | Description |
---|---|---|
model |
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. |
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.common.css'; 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.common.css'; 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 a dxEvent or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
model |
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 });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
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.
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.
Use the ValidationMessageMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto
and Always
.
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.
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"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
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
Zoom level determines the size of a date range displayed on a single calendar page.
Use the CalendarZoomLevel
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month
, Year
, Decade
, and Century
.
If you have technical questions, please create a support ticket in the DevExpress Support Center.