DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Overview

The DateRangeBox component allows users to select a date range with ease. The component includes input boxes for start/end dates and a drop-down date picker.

DevExtreme Accessibility Compliance
DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo’s accessibility level, click the Run AXE® Validation button to launch the AXE® web accessibility evaluation tool.
All trademarks or registered trademarks are property of their respective owners. AXE® Terms of Use
The overall accessibility level of your application depends on the DateRangeBox features used.
Backend API
import React, { useCallback, useState } from 'react'; import DateRangeBox from 'devextreme-react/date-range-box'; const msInDay = 1000 * 60 * 60 * 24; const now = new Date(); const lastDay = new Date(now.getFullYear(), now.getMonth() + 1, 0).getDate(); const initialValue: [Date, Date] = [ new Date(now.getTime() - msInDay * 3), new Date(now.getTime() + msInDay * 3), ]; const min = new Date(now.setDate(1)); const max = new Date(now.setDate(lastDay)); function convertRangeToDays([startDate, endDate]: [Date, Date]) { const diffInDay = Math.floor(Math.abs((endDate.valueOf() - startDate.valueOf()) / msInDay)); return diffInDay + 1; } export default function App() { const [selectedDays, setSelectedDays] = useState(convertRangeToDays(initialValue)); const onCurrentValueChange = useCallback( ({ value: [startDate, endDate] }) => { let daysCount = 0; if (startDate && endDate) { daysCount = convertRangeToDays([startDate, endDate]); } setSelectedDays(daysCount); }, [setSelectedDays], ); return ( <div className="dx-fieldset"> <div className="dx-field"> <div className="dx-field-label multiline-label"> <span>Default functionality</span> <div className="selected-days-wrapper "> <span>Days selected: </span> <span>{selectedDays}</span> </div> </div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} onValueChanged={onCurrentValueChange} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Custom format</div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} displayFormat="EEEE, MMM dd" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Use buttons to apply selection</div> <div className="dx-field-value"> <DateRangeBox applyValueMode="useButtons" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Single-calendar view</div> <div className="dx-field-value"> <DateRangeBox multiView={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Calendar only appears on icon click</div> <div className="dx-field-value"> <DateRangeBox openOnFieldClick={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Limit available dates (this month)</div> <div className="dx-field-value"> <DateRangeBox min={min} max={max} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Disable out of range selection</div> <div className="dx-field-value"> <DateRangeBox disableOutOfRangeSelection={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Clear button</div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} showClearButton /> </div> </div> </div> ); }
import React, { useCallback, useState } from 'react'; import DateRangeBox from 'devextreme-react/date-range-box'; const msInDay = 1000 * 60 * 60 * 24; const now = new Date(); const lastDay = new Date(now.getFullYear(), now.getMonth() + 1, 0).getDate(); const initialValue = [new Date(now.getTime() - msInDay * 3), new Date(now.getTime() + msInDay * 3)]; const min = new Date(now.setDate(1)); const max = new Date(now.setDate(lastDay)); function convertRangeToDays([startDate, endDate]) { const diffInDay = Math.floor(Math.abs((endDate.valueOf() - startDate.valueOf()) / msInDay)); return diffInDay + 1; } export default function App() { const [selectedDays, setSelectedDays] = useState(convertRangeToDays(initialValue)); const onCurrentValueChange = useCallback( ({ value: [startDate, endDate] }) => { let daysCount = 0; if (startDate && endDate) { daysCount = convertRangeToDays([startDate, endDate]); } setSelectedDays(daysCount); }, [setSelectedDays], ); return ( <div className="dx-fieldset"> <div className="dx-field"> <div className="dx-field-label multiline-label"> <span>Default functionality</span> <div className="selected-days-wrapper "> <span>Days selected: </span> <span>{selectedDays}</span> </div> </div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} onValueChanged={onCurrentValueChange} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Custom format</div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} displayFormat="EEEE, MMM dd" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Use buttons to apply selection</div> <div className="dx-field-value"> <DateRangeBox applyValueMode="useButtons" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Single-calendar view</div> <div className="dx-field-value"> <DateRangeBox multiView={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Calendar only appears on icon click</div> <div className="dx-field-value"> <DateRangeBox openOnFieldClick={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Limit available dates (this month)</div> <div className="dx-field-value"> <DateRangeBox min={min} max={max} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Disable out of range selection</div> <div className="dx-field-value"> <DateRangeBox disableOutOfRangeSelection={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Clear button</div> <div className="dx-field-value"> <DateRangeBox defaultValue={initialValue} showClearButton /> </div> </div> </div> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render(<App />, document.getElementById('app'));
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.3/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.3/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
<!DOCTYPE html> <html lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/24.1.3/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.demo-container { height: 690px; } .dx-field { padding: 8px; } .selected-days-wrapper { font-size: 12px; opacity: 0.5; } .multiline-label { padding-top: 0; }

This demo illustrates how to apply the following DateRangeBox settings:

  • value An array where you can specify the selected range (start/end dates). The DateRangeBox also allows you to define start/end dates separately. For this purpose, use the startDate and endDate properties instead.

  • displayFormat Date display format. You can use one of our predefined formats or specify a custom format as needs dictate. This demo illustrates the latter.

  • disabled
    Specifies whether the DateRangeBox responds to user interaction.

  • showClearButton Displays a button that clears DateRangeBox values.

  • multiView Switches between our single-month and two-month dropdown calendar.

  • applyValueMode
    Defines whether the selected value is applied instantly or after a user clicks the Apply button.

To get started with the DevExtreme DateRangeBox component, refer to the Getting Started with DateRangeBox tutorial.