React DateBox Props

An object defining configuration options for the DateBox widget.

See Also

acceptCustomValue

Specifies whether or not the widget allows an end-user to enter a custom value.

Type:

Boolean

Default Value: true

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

adaptivityEnabled

Specifies whether or not adaptive widget rendering is enabled on a small screen.

Type:

Boolean

Default Value: false

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 widget to have a more compact representation. For this purpose, assign true to the adaptivityEnabled option. In the adaptive mode, the date box is displayed without the digital clock face.

applyButtonText

The text displayed on the Apply button.

Type:

String

Default Value: 'OK'

applyValueMode

Specifies the way an end-user applies the selected value.

Type:

String

Default Value: 'instantly'
Accepted Values: 'instantly' | 'useButtons'

The option 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 option.

  • "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".

Use the EditorApplyValueMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Instantly and UseButtons.

buttons[]

Allows you to add custom buttons to the input text field.

Type:

Array<String | Object>

Default Value: undefined
Accepted Values: 'clear' | 'dropDown'

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

calendarOptions

Configures the calendar's value picker. Applies only if the pickerType is "calendar".

Default Value: {}

You can specify most of the Calendar options in this object except those listed below. These options are overridden by their DateBox counterparts.

NOTE
In Angular and Vue, the nested component that configures the calendarOptions option does not support event bindings and two-way property bindings.

cancelButtonText

The text displayed on the Cancel button.

Type:

String

Default Value: 'Cancel'

dateOutOfRangeMessage

Specifies the message displayed if the specified date is later than the max value or earlier than the min value.

Type:

String

Default Value: 'Value is out of range'

dateSerializationFormat

Specifies the date-time value serialization format. Use it only if you do not specify the value at design time.

Type:

String

Default Value: undefined

Without a value, the widget cannot detect its format. In this case, specify the dateSerializationFormat option that supports the following formats:

  • "yyyy-MM-dd" - a local date

  • "yyyy-MM-ddTHH:mm:ss" - local date and time

  • "yyyy-MM-ddTHH:mm:ssZ" - the UTC date and time

  • "yyyy-MM-ddTHH:mm:ssx" - date and time with a timezone

This option applies only if the forceIsoDateParsing field is set to true in the global configuration object.

NOTE
If you are going to change the value using the API, make sure that it has the same format that you specified in this option.

deferRendering

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.

Type:

Boolean

Default Value: true

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

disabledDates

Specifies dates that users cannot select. Applies only if pickerType is "calendar".

Type:

Array<Date>

|

Function

Function parameters:
data:

Object

Information about the checked date.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

date

Date

The currently checked date.

view

String

The current view: "month", "year", "decade", or "century".

Return Value:

Boolean

true if the date should be disabled; otherwise false.

Default Value: null

jQuery
index.js
$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        disabledDates: [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ]
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-date-box ...
    [disabledDates]="disabledDates">
</dx-date-box>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disabledDates: Date[] = [ 
        new Date("07/1/2017"),  
        new Date("07/2/2017"), 
        new Date("07/3/2017") 
    ];
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxDateBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxDateBoxModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxDateBox ...
        :disabled-dates="disabledDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            disabledDates: [ 
                new Date("07/1/2017"),  
                new Date("07/2/2017"), 
                new Date("07/3/2017") 
            ]
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    constructor() {
        this.disabledDates = [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ];
    }
    render() {
        return (
            <DateBox ...
                disabledDates={this.disabledDates} 
            />
        );
    }
}
export default App;

... or a function that specifies whether the currently checked date is disabled.

jQuery
index.js
$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        disabledDates: function(args) {
            var dayOfWeek = args.date.getDay(),
                month = args.date.getMonth(),
                isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ),
                isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-date-box ...
    [disabledDates]="disableDates">
</dx-date-box>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    disableDates(args) {
        var dayOfWeek = args.date.getDay(),
            month = args.date.getMonth(),
            isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ),
            isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxDateBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxDateBoxModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxDateBox ...
        :disabled-dates="disableDates"
    />
</template>

<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    methods: {
        disableDates(args) {
            var dayOfWeek = args.date.getDay(),
                month = args.date.getMonth(),
                isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ),
                isMarch = (args.view === "year" || args.view === "month") && month === 2;

            return isWeekend || isMarch;
        }
    }
}
</script>
React
App.js
import React from 'react';

import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    disableDates(args) {
        var dayOfWeek = args.date.getDay(),
            month = args.date.getMonth(),
            isWeekend = args.view === "month" && (dayOfWeek === 0 || dayOfWeek === 6 ),
            isMarch = (args.view === "year" || args.view === "month") && month === 2;

        return isWeekend || isMarch;
    }
    render() {
        return (
            <DateBox ...
                disabledDates={this.disableDates} 
            />
        );
    }
}
export default App;

displayFormat

Specifies the date display format. Ignored if the pickerType option is "native"

Type:

Format

Default Value: null

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.

View Demo

See Also

dropDownButtonComponent

An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

dropDownButtonRender

An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

dropDownButtonTemplate

Specifies a custom template for the drop-down button.

Type:

template

Template Data:
Name Type Description
icon

String

The button's icon.

text

String

The button's text.

Default Name: 'dropDownButton'

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#dateBoxContainer").dxDateBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-date-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-date-box>
import { DxDateBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDateBoxModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxDateBox ...
        :element-attr="dateBoxAttributes">
    </DxDateBox>
</template>

<script>
import DxDateBox from 'devextreme-vue/date-box';

export default {
    components: {
        DxDateBox
    },
    data() {
        return {
            dateBoxAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import DateBox from 'devextreme-react/date-box';

class App extends React.Component {
    dateBoxAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <DateBox ...
                elementAttr={this.dateBoxAttributes}>
            </DateBox>
        );
    }
}
export default App;

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: true

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

inputAttr

Specifies the attributes to be passed on to the underlying HTML element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#dateBoxContainer").dxDateBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});
Angular
HTML
TypeScript
<dx-date-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-date-box>
import { DxDateBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxDateBoxModule
    ],
    // ...
})
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().DateBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().DateBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

interval

Specifies the interval between neighboring values in the popup list in minutes.

Type:

Number

Default Value: 30

NOTE
This option applies only if the type option is set to "time" and the pickerType is "list".

invalidDateMessage

Specifies the message displayed if the typed value is not a valid date or time.

Type:

String

Default Value: 'Value must be a date or time'

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Boolean

Default Value: true

NOTE
When you use async rules, isValid is true if the status is "pending" or "valid".
See Also

max

The last date that can be selected within the widget.

Type:

Date

|

Number

|

String

Default Value: undefined

NOTE
If this option is undefined, pickerType - "rollers", type - "date" or "datetime", the widget renders values up to 50 years from the current date.
See Also

maxLength

Specifies the maximum number of characters you can enter into the textbox.

Type:

String

|

Number

Default Value: null

If the number of entered characters reaches the value assigned to this option, the widget does not allow you to enter any more characters.

maxZoomLevel Deprecated

Use the calendarOptions property instead.

Specifies the maximum zoom level of a calendar, which is used to pick the date.

Type:

String

Default Value: 'month'
Accepted Values: 'century' | 'decade' | 'month' | 'year'

The zoom level ascends from "month" to "century" ("month"->"year"->"decade"->"century").

The option makes sense only if the pickerType option is set to "calendar".

Use the CalendarZoomLevel enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month, Year, Decade, and Century.

min

The minimum date that can be selected within the widget.

Type:

Date

|

Number

|

String

Default Value: undefined

NOTE
If this option is undefined, pickerType - "rollers", type - "date" or "datetime", the widget renders values from 01/01/1900.
See Also

minZoomLevel Deprecated

Use the calendarOptions property instead.

Specifies the minimal zoom level of a calendar, which is used to pick the date.

Type:

String

Default Value: 'century'
Accepted Values: 'century' | 'decade' | 'month' | 'year'

The zoom level ascends from "month" to "century" ("month"->"year"->"decade"->"century").

The option makes sense only if the pickerType option is set to "calendar".

Use the CalendarZoomLevel enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Month, Year, Decade, and Century.

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

Specify this option if the widget lies within an HTML form that will be submitted.

If you configure the widget as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this option to bind the widget to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.

onChange

A function that is executed when the widget loses focus after the text field's content was changed using the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onClosed

A function that is executed once the drop-down editor is closed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Default Value: null

onCopy

A function that is executed when the widget's input has been copied.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onCut

A function that is executed when the widget's input has been cut.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onDisposing

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onEnterKey

A function that is executed when the Enter key has been pressed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

NOTE
This function is executed after the onKeyUp, onKeyDown, and onKeyPress functions.

onFocusIn

A function that is executed when the widget gets focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

DateBox

The widget's instance.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onFocusOut

A function that is executed when the widget loses focus.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

DateBox

The widget's instance.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onInitialized

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onInput

A function that is executed each time the widget's input is changed while the widget is focused.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onKeyDown

A function that is executed when a user is pressing a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onKeyPress

A function that is executed when a user presses a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

IMPORTANT
The keyPress event is removed from the web standards and will be deprecated in modern browsers soon. Refer to the MDN topic for details.

onKeyUp

A function that is executed when a user releases a key on the keyboard.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onOpened

A function that is executed once the drop-down editor is opened.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

Model data. Available only if you use Knockout.

fullName

String

The path to the modified option that includes all parent options.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

component

DateBox

The widget's instance.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

Default Value: null

onPaste

A function that is executed when the widget's input has been pasted.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onValueChanged

A function that is executed after the widget's value is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DateBox

The widget's instance.

element

HTMLElement | jQuery

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

Model data. Available only if Knockout is used.

previousValue

Object

The widget's previous value.

value

Object

The widget's new value.

Default Value: null

opened

Specifies whether or not the drop-down editor is displayed.

Type:

Boolean

Default Value: false
Raised Events: onOpened onClosed

openOnFieldClick

Specifies whether a user can open the drop-down list by clicking a text field.

Type:

Boolean

Default Value: false

pickerType

Specifies the type of the date/time picker.

Type:

String

Default Value: 'calendar', 'native' (iOS, Android), 'rollers' (Android below version 4.4, mobile devices)
Accepted Values: 'calendar' | 'list' | 'native' | 'rollers'

This option accepts the following values.

  • "native"
    The picker type depends on the current platform or web browser.

  • "calendar"
    The date box uses the Calendar widget to pick data. This value applies only when the type option is set to "date" or "datetime".

  • "rollers"
    The widget uses rollers to pick the date and time.

  • "list"
    The widget uses the list of time values to pick the time. This value applies only when the type option is set to "time".

Use the DateBoxPickerType enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Native, Calendar, Rollers, and List.

placeholder

Specifies a placeholder for the input field.

Type:

String

Default Value: ''

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

Specifies whether the editor is read-only.

Type:

Boolean

Default Value: false

When this option 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 option to false:

    jQuery
    index.js
    $(function() {
        $("#dateBoxContainer").dxDateBox({
            // ...
            buttons: [{
                name: "myCustomButton",
                location: "after",
                options: {
                    onClick: function(e) {
                        // ...
                    },
                    disabled: false
                }
            }]
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-date-box ... >
        <dxi-button
            name="myCustomButton"
            location="after"
            [options]="myCustomButtonConfig">
        </dxi-button>
    </dx-date-box>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxDateBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxDateBoxModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxDateBox ... >
            <DxDateBoxButton
                name="myCustomButton"
                location="after"
                :options="myCustomButtonConfig"
            />
        </DxDateBox>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DxDateBox, {
        DxButton as DxDateBoxButton
    } from 'devextreme-vue/date-box';
    
    export default {
        components: {
            DxDateBox,
            DxDateBoxButton
        },
        data() {
            return {
                myCustomButtonConfig: {
                    onClick: (e) => {
                        // ...
                    },
                    disabled: false
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DateBox, {
        Button as DateBoxButton
    } from 'devextreme-react/date-box';
    
    class App extends React.Component {
        myCustomButtonConfig = {
            onClick: (e) => {
                // ...
            },
            disabled: false
        };
        render() {
            return (
                <DateBox>
                    <DateBoxButton
                        name="myCustomButton"
                        location="after"
                        options={this.myCustomButtonConfig}
                    />
                </DateBox>
            );
        }
    }
    export default App;

    You can also hide a custom action button when the widget becomes read-only. Set the button's visible option to false in the onOptionChanged function. To get the button, use the getButton(name) method:

    jQuery
    index.js
    $(function() {
        $("#dateBoxContainer").dxDateBox({
            // ...
            buttons: [{
                name: "myCustomButton",
                // ...
            }],
            onOptionChanged: function(e) {
                if(e.name == "readOnly") {
                    var myButton = e.component.getButton("myCustomButton");
                    myButton.option("visible", !e.value); // Hide the button when readOnly: true
                }
            }
        });
    });
    Angular
    app.component.html
    app.component.ts
    app.module.ts
    <dx-date-box ...
        (onOptionChanged)="changeButtonState">
        <dxi-button
            name="myCustomButton"
            ...
        ></dxi-button>
    </dx-date-box>
    import { Component } from '@angular/core';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
    }
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxDateBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxDateBoxModule
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxDateBox ...
            @option-changed="changeButtonState">
            <DxDateBoxButton
                name="myCustomButton"
                ...
            />
        </DxDateBox>
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DxDateBox, {
        DxButton as DxDateBoxButton
    } from 'devextreme-vue/date-box';
    
    export default {
        components: {
            DxDateBox,
            DxDateBoxButton
        },
        data() {
            return {
                // ...
            }
        },
        methods: {
            changeButtonState(e) {
                if(e.name == 'readOnly') {
                    let myButton = e.component.getButton('myCustomButton');
                    myButton.option('visible', !e.value); // Hide the button when readOnly: true
                }
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import DateBox, {
        Button as DateBoxButton
    } from 'devextreme-react/date-box';
    
    class App extends React.Component {
        changeButtonState(e) {
            if(e.name == 'readOnly') {
                let myButton = e.component.getButton('myCustomButton');
                myButton.option('visible', !e.value); // Hide the button when readOnly: true
            }
        }
        render() {
            return (
                <DateBox ...
                    onOptionChanged={this.changeButtonState}>
                    <DateBoxButton
                        name="myCustomButton"
                        ...
                    />
                </DateBox>
            );
        }
    }
    export default App;

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget 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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

showAnalogClock

Specifies whether to show the analog clock in the value picker. Applies only if type is "datetime" and pickerType is "calendar".

Type:

Boolean

Default Value: true

showClearButton

Specifies whether to display the Clear button in the widget.

Type:

Boolean

Default Value: false

The Clear button sets the widget value to null.

NOTE
The Clear button is displayed if the pickerType option value is not "native". Otherwise, the Clear button is displayed only if the native widget implementation includes it.

showDropDownButton

Specifies whether the drop-down button is visible.

Type:

Boolean

Default Value: true

spellcheck

Specifies whether or not the widget checks the inner text for spelling mistakes.

Type:

Boolean

Default Value: false

stylingMode

Specifies how the widget's text field is styled.

Type:

String

Default Value: 'outlined', 'underlined' (Material)
Accepted Values: 'outlined' | 'underlined' | 'filled'

The following styles are available:

Text Editor Styling Modes

Use the EditorStylingMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Outlined, Underlined, and Filled.

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

text

The read-only option that holds the text displayed by the widget input element.

Type:

String

Read-only

type

A format used to display date/time information.

Type:

String

Default Value: 'date'
Accepted Values: 'date' | 'datetime' | 'time'

You can assign the following values to this option:

  • date - the widget displays only the date;
  • time - the widget displays only the time;
  • datetime - the widget displays both the date and time.

Use the DateBoxType enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Date, DateTime, and Time.

useMaskBehavior

Specifies whether to control user input using a mask created based on the displayFormat.

Type:

Boolean

Default Value: false

validationError

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

Type:

Object

Default Value: null

See Also

validationErrors

An array of the validation rules that failed.

Type:

Array<Object>

Default Value: null

validationMessageMode

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

Type:

String

Default Value: 'auto'
Accepted Values: 'always' | 'auto'

The following option values are possible:

  • auto
    The tooltip with the message is displayed when the editor is in focus.
  • always
    The tooltip with the message is not hidden when the editor loses focus.

Use the ValidationMessageMode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto and Always.

validationStatus

Indicates or specifies the current validation status.

Type:

String

Default Value: 'valid'
Accepted Values: 'valid' | 'invalid' | 'pending'

The following table illustrates the validation status indicators:

validationStatus Indicator
"pending" DevExtreme editor validation status: pending
"valid" DevExtreme editor validation status: valid
"invalid" DevExtreme editor validation status: invalid

value

An object or a value specifying the date and time currently selected using the date box.

Type:

Date

|

Number

|

String

Default Value: null
Raised Events: onValueChanged

You can specify the current widget value using any of the following formats.

  • Date
    Specifies the date directly.

  • Number
    Specifies the date using a timestamp (total milliseconds since 1970/01/01).

  • String
    Specifies the date using a string value. The widget supports the following formats of a date string.

    • "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 the widget value is changed by an end-user, the new value is saved in the same format as the initial value.

View Demo

See Also

valueChangeEvent

Specifies the DOM events after which the widget's value should be updated.

Type:

String

Default Value: 'change'

This option accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", and "focusout", but you can use other events as well.

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }