JavaScript/jQuery DateBox Options
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
adaptivityEnabled
While displaying DateBox in your app, you may want to use different layouts for different screen sizes. While desktop monitors provide enough space, mobile screens do not. In this case, you can enable the UI component to have a more compact representation. For this purpose, assign true to the adaptivityEnabled property. In the adaptive mode, the date box is displayed without the digital clock face.
applyValueMode
The property accepts the following values.
"useButtons"
Enables an end user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively. When the pickerType is 'calendar', choosing this mode activates the showTodayButton property."instantly"
Applies the selected value immediately after a user clicks the required value in the drop-down menu. This mode cannot be used if the pickerType is "rollers" or the type is "datetime".
buttons[]
Array<DropDownPredefinedButton | TextEditorButton>
Built-in buttons should also be declared in this array. You can find an example in the following demo:
calendarOptions
Configures the calendar's value picker. Applies only if the pickerType is "calendar".
You can specify most of the Calendar properties in this object except those listed below. These properties are overridden by their DateBox counterparts.
dateOutOfRangeMessage
Specifies the message displayed if the specified date is later than the max value or earlier than the min value.
dateSerializationFormat
Date-time serialization involves date-time value conversion into a string format for storage or transmission. To ensure proper format detection, specify this property.
Use LDML patterns to pass custom format strings to this property.
For instance, you can specify the following patterns:
"yyyy-MM-dd"
A date."yyyy-MM-ddTHH:mm:ss"
Local date and time."yyyy-MM-ddTHH:mm:ssZ"
Date and time in UTC."yyyy-MM-ddTHH:mm:ssx"
,"yyyy-MM-ddTHH:mm:ssxx"
,"yyyy-MM-ddTHH:mm:ssxxx"
Date and time with a timezone.
You can use this property only if you do not specify the initial value. dateSerializationFormat is calculated automatically if you pass a value in the initial configuration.
If you specify this property, the value will be a string, not a Date object.
If you use API to change the value, make sure that the value has the same format that you specified in this property.
This property takes effect only if the forceIsoDateParsing field is set to true in the global configuration object.
See Also
deferRendering
Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.
disabledDates
Specifies dates that users cannot select. Applies only if pickerType is "calendar".
This property accepts an array of dates:
- $(function() {
- $("#dateBoxContainer").dxDateBox({
- // ...
- disabledDates: [
- new Date("07/1/2017"),
- new Date("07/2/2017"),
- new Date("07/3/2017")
- ]
- });
- });
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.
- $(function() {
- $("#dateBoxContainer").dxDateBox({
- // ...
- 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;
- }
- });
- });
displayFormat
Specifies the date display format. Ignored if the pickerType property is "native"
Set useMaskBehavior to true to control user input according to the display format.
The default display format is selected automatically based on the current locale.
See Also
dropDownOptions
Configures the drop-down field which holds the content.
See Popup Configuration for properties that you can specify in this object.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
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"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
inputAttr
To improve accessibility, use this property to specify aria-label for the component.
- $(function(){
- $("#dateBoxContainer").dxDateBox({
- // ...
- inputAttr: {
- 'aria-label': 'your-label',
- },
- });
- });
You do not need to specify aria-label
if you use label.
interval
isDirty
This property is a read-only flag. You can use it to check if the editor value changed.
- $(() => {
- const dateBox = $('#dateBox').dxDateBox({
- // ...
- }).dxDateBox('instance');
- $('#button').dxButton({
- // ...
- onClick () {
- if (dateBox.option('isDirty')) {
- DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
- }
- }
- });
- });
See Also
isValid
See Also
labelMode
Specifies the label's display mode.
This property can have one of the following values:
labelMode | Description | Illustration |
---|---|---|
"static" | The label is displayed above the input field. | |
"floating" | The label is used as a placeholder, but when the editor gets focus, the label moves to the position above the input field. |
|
"hidden" | The label is hidden. | |
"outside" | The label is outside. |
If autofill is enabled in the browser, we do not recommend that you use "floating" mode. The autofill values will overlap the label when it is displayed as a placeholder. Use "static" mode instead.
max
You can use the following formats to specify the maximum date:
Date
Specifies the date directly.Number
Specifies the date with a timestamp (total milliseconds since 1970/01/01).String
Specifies the date as a string value. The UI component supports the following date string formats:- "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, "20170327T16:54:10+03")
If this property is undefined, pickerType - "rollers", type - "date" or "datetime", the UI component renders values up to 50 years from the current date.
If you set the type property to 'time', you still need to use a full
Date()
as the max, notHH:mm
.
See Also
min
You can use the following formats to specify the minimum date:
Date
Specifies the date directly.Number
Specifies the date with a timestamp (total milliseconds since 1970/01/01).String
Specifies the date as a string value. The UI component supports the following date string formats:- "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, "20170327T16:54:10+03")
If this property is undefined, pickerType - "rollers", type - "date" or "datetime", the UI component renders values from 01/01/1900.
If you set the type property to 'time', you still need to use a full
Date()
as the min, notHH:mm
.
See Also
onChange
A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onClosed
Name | Type | Description |
---|---|---|
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. |
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
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. |
onCopy
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onCut
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
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. |
onEnterKey
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onFocusIn
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onFocusOut
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onInitialized
Name | Type | Description |
---|---|---|
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. |
onInput
A function that is executed each time the UI component's input is changed while the UI component is focused.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onKeyDown
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onKeyUp
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onOpened
Name | Type | Description |
---|---|---|
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. |
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
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. |
onPaste
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
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. |
onValueChanged
A function that is executed after the UI component's value is changed.
Name | Type | Description |
---|---|---|
value |
The UI component's new value. |
|
previousValue |
The UI component's previous value. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically. |
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. |
pickerType
This property accepts the following values:
"calendar"
The DateBox displays the Calendar UI component for users to select a date. Set the type property to "date" or "datetime" to use this picker type."list"
The DateBox displays a list of time values. Set the type property to "time" to use this picker type."native"
The picker type depends on the current platform or web browser."rollers"
The DateBox displays rollers for users to select date and time. Users cannot edit the selected value in the input field.NOTEThis picker type is designed for mobile devices. For desktop applications, use one of the others.
placeholder
This text is also shown in the date picker's title in the following cases:
- If the pickerType is "rollers".
- If the application runs on an iOS device and the pickerType is not "native".
readOnly
When this property is set to true, the following applies:
- The editor's value cannot be changed using the UI.
- Built-in action buttons are invisible.
Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:
index.js- $(function() {
- $("#dateBoxContainer").dxDateBox({
- // ...
- buttons: [{
- name: "myCustomButton",
- location: "after",
- options: {
- onClick: function(e) {
- // ...
- },
- disabled: false
- }
- }]
- });
- });
You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:
index.js- $(function() {
- $("#dateBoxContainer").dxDateBox({
- // ...
- buttons: [{
- name: "myCustomButton",
- // ...
- }],
- onOptionChanged: function(e) {
- if(e.name == "readOnly") {
- const myButton = e.component.getButton("myCustomButton");
- myButton.option("visible", !e.value); // Hide the button when readOnly: true
- }
- }
- });
- });
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
- });
showAnalogClock
Specifies whether to show the analog clock in the value picker. Applies only if type is "datetime" and pickerType is "calendar".
showClearButton
The Clear button calls the reset method.
stylingMode
The following styles are available:
You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
type
You can assign the following values to this property:
- date - the UI component displays only the date;
- time - the UI component displays only the time;
- datetime - the UI component displays both the date and time.
useMaskBehavior
Specifies whether to control user input using a mask created based on the displayFormat.
drop
event is not supported for masked input.See Also
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.
validationMessagePosition
Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
This property also applies position rules to the component's inner validation message.
The following example positions a validation message at the component's right:
- $(function() {
- $("#dateBoxContainer").dxDateBox({
- // ...
- validationMessagePosition: 'right'
- }).dxValidator({
- validationRules: [{
- type: 'required',
- message: 'Required',
- }],
- });
- });
validationStatus
The following table illustrates the validation status indicators:
validationStatus | Indicator |
---|---|
"pending" |
![]() |
"valid" |
![]() |
"invalid" |
![]() |
When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:
- $(function() {
- const dateBox = $("#dateBoxContainer").dxDateBox({
- // ...
- }).dxDateBox("instance");
- function setInvalidStatus(message) {
- dateBox.option({
- validationStatus: "invalid",
- validationErrors: [{ message: message }]
- });
- }
- });
value
You can use the following formats to specify the current UI component value:
Date
Specifies the date directly.Number
Specifies the date with a timestamp (total milliseconds since 1970/01/01).String
Specifies the date as a string value. The UI component supports the following date string formats:- "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, "20170327T16:54:10+03")
If an end user changes the UI component value, the new value is saved in the same format as the initial value.
See Also
valueChangeEvent
Specifies the DOM events after which the UI component's value should be updated.
This property accepts a single event name or several names separated by spaces.
The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.
See Also
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"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.