JavaScript/jQuery Calendar API
The Calendar is a widget that displays a calendar and allows an end user to select the required date within a specified date range.
DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.
The following code shows how to create the Calendar widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.
jQuery
$(function () { $("#calendar").dxCalendar({ min: new Date(2000, 1, 1), max: new Date(2029, 12, 31), firstDayOfWeek: 1, value: new Date() }); });
<div id="calendar"></div>
Angular
<dx-calendar [min]="minDate" [max]="maxDate" [firstDayOfWeek]="1" [(value)]="currentDate"> </dx-calendar>
import { DxCalendarModule } from "devextreme-angular"; // ... export class AppComponent { minDate = new Date(2000, 0, 1); maxDate = new Date(2029, 11, 31); currentDate = new Date(); } @NgModule({ imports: [ // ... DxCalendarModule ], // ... })
AngularJS
<div ng-controller="DemoController"> <div dx-calendar="{ min: minDate, max: maxDate, firstDayOfWeek: 1, bindingOptions: { value: 'currentDate' } }"></div> </div>
angular.module("DemoApp", ["dx"]) .controller("DemoController", function ($scope) { $scope.minDate = new Date(2000, 0, 1); $scope.maxDate = new Date(2029, 11, 31); $scope.currentDate = new Date(); });
Knockout
<div data-bind="dxCalendar: { min: new Date(2000, 1, 1), max: new Date(2029, 12, 31), firstDayOfWeek: 1, value: currentDate }"></div>
var viewModel = { currentDate: ko.observable(new Date()) }; ko.applyBindings(viewModel);
ASP.NET MVC Controls
@(Html.DevExtreme().Calendar() .ID("calendar") .Min(new DateTime(2000, 1, 1)) .Max(new DateTime(2029, 12, 31)) .FirstDayOfWeek(FirstDayOfWeek.Monday) .Value(DateTime.Now) )
@(Html.DevExtreme().Calendar() _ .ID("calendar") _ .Min(New DateTime(2000, 1, 1)) _ .Max(New DateTime(2029, 12, 31)) _ .FirstDayOfWeek(FirstDayOfWeek.Monday) _ .Value(DateTime.Now) )
See Also
Options
Name | Description |
---|---|
accessKey |
Specifies the shortcut key that sets focus on the widget. |
activeStateEnabled |
Specifies whether or not the widget changes its state when interacting with a user. |
cellTemplate |
Specifies a custom template for calendar cells. |
dateSerializationFormat |
Specifies the date-time value serialization format. Use it only if you do not specify the value at design time. |
disabled |
Specifies whether the widget responds to user interaction. |
disabledDates |
Specifies dates to be disabled. |
elementAttr |
Specifies the attributes to be attached to the widget's root element. |
firstDayOfWeek |
Specifies the first day of a week. |
focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
height |
Specifies the widget's height. |
hint |
Specifies text for a hint that appears when a user pauses on the widget. |
hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
isValid |
Specifies whether the editor's value is valid. |
max |
The latest date the widget allows to select. |
maxZoomLevel |
Specifies the maximum zoom level of the calendar. |
min |
The earliest date the widget allows to select. |
minZoomLevel |
Specifies the minimum zoom level of the calendar. |
name |
The value to be assigned to the |
onDisposing |
A function that is executed before the widget is disposed of. |
onInitialized |
A function that is executed only once, after the widget is initialized. |
onOptionChanged |
A function that is executed after a widget option is changed. |
onValueChanged |
A function that is executed after the widget's value is changed. |
readOnly |
A Boolean value specifying whether or not the widget is read-only. |
rtlEnabled |
Switches the widget to a right-to-left representation. |
showTodayButton |
Specifies whether or not the widget displays a button that selects the current date. |
tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
validationError |
Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option. |
validationMessageMode |
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
value |
An object or a value specifying the date and time currently selected in the calendar. |
visible |
Specifies whether the widget is visible. |
width |
Specifies the widget's width. |
zoomLevel |
Specifies the current calendar zoom level. |
Methods
Name | Description |
---|---|
beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
dispose() |
Disposes of all the resources allocated to the Calendar instance. |
element() |
Gets the root widget element. |
endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
focus() |
Sets focus on the widget. |
getInstance(element) |
Gets the instance of a widget found using its DOM node. |
instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
off(eventName) |
Detaches all event handlers from a single event. |
off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
on(eventName, eventHandler) |
Subscribes to an event. |
on(events) |
Subscribes to events. |
option() |
Gets all widget options. |
option(optionName) |
Gets the value of a single option. |
option(optionName, optionValue) |
Updates the value of a single option. |
option(options) |
Updates the values of several options. |
registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
reset() |
Resets the value option to the default value. |
Events
Name | Description |
---|---|
disposing |
Raised before the widget is disposed of. |
initialized |
Raised only once, after the widget is initialized. |
optionChanged |
Raised after a widget option is changed. |
valueChanged |
Raised after the widget's value is changed. |
Default Cell Template
By default, a predefined cell template is applied to display calendar cells. This template is based on certain fields of an object holding cell information. Below is the list of these fields. If the default cell template is not appropriate for your task, implement a custom cell template based on these fields.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.