JavaScript/jQuery DateBox Options

See Also

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

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.

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.

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

View Demo

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 properties in this object except those listed below. These properties are overridden by their DateBox counterparts.

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

Without a value, the UI component cannot detect its format. In this case, specify the dateSerializationFormat property 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 property applies only if the forceIsoDateParsing field is set to true in the global configuration object.

See Also

• Troubleshooting - Date values are parsed or serialized incorrectly

View Demo

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") 
        ]
    });
});

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

View Demo

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

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

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.light.css';

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

export default {
    components: {
        DxDateBox
    },
    methods: {
        disableDates(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;
        }
    }
}
</script>

import React from 'react';

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

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

class App extends React.Component {
    disableDates(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;
    }
    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

View Demo

See Also

• Custom Templates

See Popup Configuration for properties that you can specify in this object.

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.

See Also

• Knockout Only - Validate a View Model
• validationErrors

See Also

• labelMode
• placeholder

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.

View Demo

See Also

• Specify the Value Range

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

View Demo

See Also

• Specify the Value Range

Specify this property if the UI component lies within an HTML form that will be submitted.

See Also

The following example shows how to subscribe to component property changes:

$(function() {
    $("#dateBoxContainer").dxDateBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-date-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-date-box>

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

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

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

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 ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxDateBox from 'devextreme-vue/date-box'; 

export default { 
    components: { 
        DxDateBox
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

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

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <DateBox ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

View Demo

See Also

• valueChangeEvent

See Also

• showDropDownButton

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.

View Demo

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

View Demo

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:

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

  jQuery

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

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

DataGrid Demo Navigation UI Demo Editors Demo

The Clear button calls the reset method.

View Demo

See Also

• dropDownButtonTemplate

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.

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

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.

View Demo

View Demo

See Also

• Value Formatting and Masked Input

See Also

• isValid

The following property 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.

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

<dx-date-box
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-date-box>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxDateBox ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <DateBox
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

You can specify the current UI component 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 UI component 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 UI component value is changed by an end-user, the new value is saved in the same format as the initial value.

View Demo

See Also

• displayFormat

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

• onValueChanged

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.