Calendar

The Calendar is a widget that displays a calendar and allows an end user to select the required date within a specified date range.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/calendar
Export: default
Calendar interactive configuration
Copy Code
Copy to Codepen
import Calendar from "devextreme/ui/calendar";

new Calendar(container, {
});

                    
Type:

Object

Configuration

An object defining configuration options for the Calendar widget.

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 or indicates 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 name attribute of the underlying HTML element.

onDisposing

A function that is executed before the widget is disposed of.

onInitialized

A function used in JavaScript frameworks to save the widget instance.

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

Specifies whether the editor 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

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

validationErrors

An array of the validation rules that failed.

validationMessageMode

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

validationStatus

Indicates or specifies the current validation status.

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.

See Also

Methods

This section describes the members used to manipulate the widget.

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.

resetOption(optionName)

Resets an option to its default value.

Events

This section describes events that this widget raises.

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.

See Also

Default Cell Template

This section lists the fields that are used in a default template for calendar cells.

Type:

Object

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