Your search did not match any results.
Calendar

Calendar

When you add a Calendar to an application, you need to specify its value in one of the following formats:

  • Date objects

  • The number of milliseconds since 00:00:00 on January 1, 1970

  • Strings that match the following patterns:

    • 'yyyy-MM-dd'
    • 'yyyy-MM-ddTHH:mm:ss'
    • 'yyyy-MM-ddTHH:mm:ssZ'
    • 'yyyy-MM-ddTHH:mm:ssx'

This demo shows how to use additional properties to customize your Calendar. You can toggle the checkboxes on the right to change the Calendar in real time.

Disable Dates

Use the min and max properties to specify the range of available dates. In this demo, these properties limit the range to three days before and after the current date. Enable the "Set minimum date" and "Set maximum date" checkboxes to apply the properties.

If you need to disable specific dates, use the disabledDates property. Toggle the "Disable weekends" checkbox to see how this setting affects the component's behavior. You can specify either an array of predefined dates or a function that determines whether a date is available.

Specify First Day of Week and Display Week Numbers

To specify the first day of the week, assign its index (0 - for Sunday, 1 - for Monday, and so on) to the firstDayOfWeek property. You can also display a column with week numbers. For this, enable the showWeekNumbers property.

The start of the first week of the year depends on the locale. If you want to apply a specific rule, use the weekNumberRule property.

Handle Value Change

Set the onValueChanged property to handle the value change. In this demo, the DateBox and the Calendar both use this property to pass values between each other, and you can use one of these components to change the date.

Customize Cell Appearance

Use the cellTemplate property to customize cell appearance. In this demo, the following customizations are applied when you toggle the "Use custom cell template" checkbox:

  • All the weekends on the Calendar become blue.

  • All the holidays become red.

  • If a column with week numbers is shown, week numbers are italicized.

You can set your own function that changes the class of the span element that contains cell text.

Other Customizations

Set the disabled property to disable the Calendar.

To specify the initial calendar view (month, year, decade, or century), set the zoomLevel property.

Backend API
Copy to CodeSandBox
Apply
Reset
import React from 'react'; import CheckBox from 'devextreme-react/check-box'; import SelectBox from 'devextreme-react/select-box'; import DateBox from 'devextreme-react/date-box'; import Calendar from 'devextreme-react/calendar'; import CustomCell, { isWeekend } from './CustomCell.js'; const zoomLevels = ['month', 'year', 'decade', 'century']; const weekNumberRules = ['auto', 'firstDay', 'firstFourDays', 'fullWeek']; const weekDays = [ { id: 0, text: 'Sunday' }, { id: 1, text: 'Monday' }, { id: 2, text: 'Tuesday' }, { id: 3, text: 'Wednesday' }, { id: 4, text: 'Thursday' }, { id: 5, text: 'Friday' }, { id: 6, text: 'Saturday' }, ]; export default function App() { const [minDateValue, setMinDateValue] = React.useState(null); const [maxDateValue, setMaxDateValue] = React.useState(null); const [weekendDisabled, setWeekendDisabled] = React.useState(null); const [firstDay, setFirstDay] = React.useState(0); const [weekNumberRule, setWeekNumberRule] = React.useState('auto'); const [showWeekNumbers, setShowWeekNumbers] = React.useState(false); const [currentValue, setCurrentValue] = React.useState(new Date()); const [useCellTemplate, setUseCellTemplate] = React.useState(null); const [disabled, setDisabled] = React.useState(false); const [zoomLevel, setZoomLevel] = React.useState('month'); const onCurrentValueChange = React.useCallback(({ value }) => { setCurrentValue(value); }, [setCurrentValue]); const onDisabledChange = React.useCallback(({ value }) => { setDisabled(value); }, [setDisabled]); const onZoomLevelChange = React.useCallback(({ value }) => { setZoomLevel(value); }, [setZoomLevel]); const onMinDateChange = React.useCallback(({ value }) => { setMinDateValue( value ? new Date(new Date().getTime() - 1000 * 60 * 60 * 24 * 3) : null, ); }, [setMinDateValue]); const onMaxDateChange = React.useCallback(({ value }) => { setMaxDateValue( value ? new Date(new Date().getTime() + 1000 * 60 * 60 * 24 * 3) : null, ); }, [setMaxDateValue]); const onDisableWeekendChange = React.useCallback(({ value }) => { setWeekendDisabled(value); }, [setWeekendDisabled]); const onFirstDayChange = React.useCallback(({ value }) => { setFirstDay(value); }, [setFirstDay]); const onWeekNumberRuleChange = React.useCallback(({ value }) => { setWeekNumberRule(value); }, [setWeekNumberRule]); const onShowWeekNumbersChange = React.useCallback(({ value }) => { setShowWeekNumbers(value); }, [setShowWeekNumbers]); const onUseCellTemplateChange = React.useCallback(({ value }) => { setUseCellTemplate(!!value); }, [setUseCellTemplate]); const isDateDisabled = React.useCallback(({ view, date }) => view === 'month' && isWeekend(date), []); const onOptionChange = React.useCallback((e) => { if (e.name === 'zoomLevel') { onZoomLevelChange(e); } }, [onZoomLevelChange]); return ( <div id="container"> <div className="calendar-container"> <Calendar value={currentValue} onValueChanged={onCurrentValueChange} onOptionChanged={onOptionChange} min={minDateValue} max={maxDateValue} disabledDates={weekendDisabled ? isDateDisabled : null} firstDayOfWeek={firstDay} weekNumberRule={weekNumberRule} showWeekNumbers={showWeekNumbers} disabled={disabled} zoomLevel={zoomLevel} cellRender={useCellTemplate ? CustomCell : null} /> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox defaultValue={false} text="Set minimum date" onValueChanged={onMinDateChange} /> </div> <div className="option"> <CheckBox defaultValue={false} text="Set maximum date" onValueChanged={onMaxDateChange} /> </div> <div className="option"> <CheckBox defaultValue={false} text="Disable weekends" onValueChanged={onDisableWeekendChange} /> </div> <div className="option"> <CheckBox defaultValue={false} text="Show week numbers" onValueChanged={onShowWeekNumbersChange} /> </div> <div className="option"> <CheckBox defaultValue={false} text="Use custom cell template" onValueChanged={onUseCellTemplateChange} /> </div> <div className="option"> <CheckBox value={disabled} text="Disable the calendar" onValueChanged={onDisabledChange} /> </div> <div className="option"> <span>First day of week</span> <SelectBox dataSource={weekDays} displayExpr="text" valueExpr="id" value={firstDay} onValueChanged={onFirstDayChange} /> </div> <div className="option"> <span>Week number rule</span> <SelectBox dataSource={weekNumberRules} value={weekNumberRule} onValueChanged={onWeekNumberRuleChange} /> </div> <div className="option"> <span>Zoom level</span> <SelectBox dataSource={zoomLevels} value={zoomLevel} onValueChanged={onZoomLevelChange} /> </div> <div className="option"> <span>Selected date</span> <DateBox id="selected-date" value={currentValue} onValueChanged={onCurrentValueChange} min={minDateValue} max={maxDateValue} /> </div> </div> </div> ); }
import React from 'react'; export function isWeekend(date) { const day = date.getDay(); return day === 0 || day === 6; } function getCellCssClass({ date, view }) { let cssClass = ''; const holidays = [[1, 0], [4, 6], [25, 11]]; if (view === 'month') { if (!date) { cssClass = 'week-number'; } else { if (isWeekend(date)) { cssClass = 'weekend'; } holidays.forEach((item) => { if (date.getDate() === item[0] && date.getMonth() === item[1]) { cssClass = 'holiday'; } }); } } return cssClass; } function CustomCell(cell) { const { text, } = cell; const className = getCellCssClass(cell); return ( <span className={className}> { text } </span> ); } export default CustomCell;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('app'), );
<!DOCTYPE html> <html> <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=1.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/22.2.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.js"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
#container { display: flex; } .calendar-container { display: flex; flex-direction: column; flex-grow: 1; align-items: center; justify-content: center; } .dx-calendar-cell:not(.dx-calendar-other-month) .weekend, .dx-calendar-cell:not(.dx-calendar-other-month) .holiday { text-shadow: none; font-weight: bold; } .dx-calendar-cell:not(.dx-calendar-other-month) .weekend { color: #3030ff; } .dx-state-disabled.dx-calendar .dx-calendar-cell:not(.dx-calendar-other-month) .weekend { color: #8080ff; } .dx-calendar-cell:not(.dx-calendar-other-month) .holiday { color: #ff3030; } .dx-state-disabled.dx-calendar .dx-calendar-cell:not(.dx-calendar-other-month) .holiday { color: #ff8080; } .dx-calendar-week-number-cell .week-number { font-style: italic; } .caption { font-weight: 500; font-size: 18px; } .options { padding: 20px; background-color: rgba(191, 191, 191, 0.15); } .option { margin-top: 10px; }
window.config = { transpiler: 'plugin-babel', meta: { 'devextreme/localization.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { '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.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@22.2.3/cjs', 'devextreme-react': 'npm:devextreme-react@22.2.3', 'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.5.18/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.65/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.37/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat@7.4.11/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@7.4.11/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class@7.4.11/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras@7.4.11/dist/inferno-extras.min.js', // 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.7.1/standalone.js', 'prettier/parser-html': 'npm:prettier@2.7.1/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.11/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);