React Calendar API
The Calendar is a UI component that displays a calendar and allows an end user to select the required date within a specified date range.
Props
An object defining configuration properties for the Calendar UI component.
| Name | Description |
|---|---|
| accessKey | Specifies the shortcut key that sets focus on the UI component. |
| activeStateEnabled | Specifies whether or not the UI component changes its state when interacting with a user. |
| 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. |
| 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 UI component responds to user interaction. |
| disabledDates | Specifies dates that users cannot select. |
| elementAttr | Specifies the global attributes to be attached to the UI component's container element. |
| firstDayOfWeek | Specifies the first day of a week. |
| focusStateEnabled | Specifies whether the UI component can be focused using keyboard navigation. |
| height | Specifies the UI component's height. |
| hint | Specifies text for a hint that appears when a user pauses on the UI component. |
| hoverStateEnabled | Specifies whether the UI component 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 UI component allows to select. |
| maxZoomLevel | Specifies the maximum zoom level of the calendar. |
| min | The earliest date the UI component 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 UI component is disposed of. |
| onInitialized | A function used in JavaScript frameworks to save the UI component instance. |
| onOptionChanged | A function that is executed after a UI component property is changed. |
| onValueChanged | A function that is executed after the UI component's value is changed. |
| readOnly | Specifies whether the editor is read-only. |
| rtlEnabled | Switches the UI component to a right-to-left representation. |
| showTodayButton | Specifies whether or not the UI component 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 UI component is visible. |
| width | Specifies the UI component's width. |
| zoomLevel | Specifies the current calendar zoom level. |
Methods
This section describes the members used to manipulate the UI component.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the UI component from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) | Specifies the device-dependent default configuration properties for this component. |
| dispose() | Disposes of all the resources allocated to the Calendar instance. |
| element() | Gets the root UI component element. |
| endUpdate() | Refreshes the UI component after a call of the beginUpdate() method. |
| focus() | Sets focus on the UI component. |
| getInstance(element) | Gets the instance of a UI component found using its DOM node. |
| instance() | Gets the UI component's instance. Use it to access other methods of the UI component. |
| 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 UI component properties. |
| option(optionName) | Gets the value of a single property. |
| option(optionName, optionValue) | Updates the value of a single property. |
| option(options) | Updates the values of several properties. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Repaints the UI component without reloading data. Call it to update the UI component's markup. |
| reset() | Resets the value property to the default value. |
| resetOption(optionName) | Resets a property to its default value. |
Events
This section describes events that this UI component raises.
| Name | Description |
|---|---|
| disposing | Raised before the UI component is disposed of. |
| initialized | Raised only once, after the UI component is initialized. |
| optionChanged | Raised after a UI component property is changed. |
| valueChanged | Raised after the UI component's value is changed. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.