Calendar

A calendar widget.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxCalendar widget displays the date on a calendar and enables a user to select the required date.

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxCalendar jQuery plug-in.

    HTML
    <div id="calendar"></div>
    JavaScript
    $("#calendar").dxCalendar({
        min: new Date(2000,1,1),
        max: new Date(2029,12,31),
        firstDayOfWeek: 0
    });
  • Knockout
    Add a div element and apply the dxCalendar binding to this element.

    HTML
    <div data-bind="dxCalendar: {
        min: new Date(2000,1,1),
        max: new Date(2029,12,31),
        firstDayOfWeek: 0
    }"></div>
  • Angular
    Add a div element and apply the dx-calendar directive to this element.

    HTML
    <div dx-calendar="{
        min: new Date(2000,1,1),
        max: new Date(2029,12,31),
        firstDayOfWeek: 0
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

You can find the detailed information on principles of working with the widget in the dxCalendar section of the Editor Widgets article.

View Demo

Watch Video

Configuration

An object defining configuration options for the dxCalendar widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

cellTemplate

The template to be used for rendering calendar cells.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

firstDayOfWeek

Specifies the first day of a week.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

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.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

onValueChanged

A handler for the valueChanged event.

readOnly

A Boolean value specifying whether or not the widget is read-only.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

showTodayButton

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

tabIndex

Specifies the widget tab index.

validationError

Holds the object that defines the error that occurred during validation.

validationMessageMode

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

value

The currently specified value.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

zoomLevel

Specifies the current calendar zoom level.

Methods

This section describes the members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

focus()

Sets focus on the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the editor's value to undefined.

Events

This section describes events exposed by this widget.

Name Description
disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.

valueChanged

Fires when the editor value changes.