React DateBox Props

See Also

• Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core

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

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

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.

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.

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

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

View Demo

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

• dateSerializationFormat
• disabledDates
• max
• min
• onValueChanged
• tabIndex
• value

$(function() {
    $("#dateBoxContainer").dxDateBox({
        type: "date",
        pickerType: "calendar",
        calendarOptions: {
            // The Calendar widget's options go here
        }
    })
});

<dx-date-box
    type="date"
    pickerType="calendar"
    [calendarOptions]="{
        // The Calendar widget's options go here
    }">
</dx-date-box>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

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 { }

<template>
    <DxDateBox
        type="date"
        picker-type="calendar"
        :calendar-options="{
            // The Calendar widget's options go here
        }"
    />
</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 {
            // ...
        }
    }
}
</script>

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 {
    // ...

    render() {
        return (
            <DateBox
                type={'date'}
                pickerType="calendar"
                calendarOptions={{
                    // The Calendar widget's options go here
                }} 
            />
        );
    }
}

export default App;

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.

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        disabledDates: [ 
            new Date("07/1/2017"),  
            new Date("07/2/2017"), 
            new Date("07/3/2017") 
        ]
    });
});

<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 { }

<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>

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.

$(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;
        }
    });
});

<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 { }

<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>

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;

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

• Format Widget Values

See Also

• SelectBox - Customize Drop-Down Button Demo
• Custom Templates

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;
  }

See Also

• Knockout Only - Validate a View Model
• Use a Custom Validation Engine

See Also

• Specify the Value Range

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

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.

See Also

• Specify the Value Range

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.

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.

See Also

• Get a Widget Instance in Angular | AngularJS | Knockout | Vue | React

See Also

• showDropDownButton

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.

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

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;

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.

DevExpress.config({
    rtlEnabled: true
});

See Also

• Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors

The Clear button sets the widget value to null.

See Also

• dropDownButtonTemplate

The following styles are available:

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.

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

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.

View Demo

See Also

• Value Formatting and Masked Input

See Also

• Use a Custom Validation Engine

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.

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.

See Also

• displayFormat

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.

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;
  }