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 Calendar features used.
Backend API
import React, { useCallback, useState } from 'react';
import CheckBox from 'devextreme-react/check-box';
import type { CheckBoxTypes } from 'devextreme-react/check-box';
import SelectBox from 'devextreme-react/select-box';
import type { SelectBoxTypes } from 'devextreme-react/select-box';
import DateBox from 'devextreme-react/date-box';
import Calendar from 'devextreme-react/calendar';
import type { CalendarTypes } from 'devextreme-react/calendar';
import CustomCell from './CustomCell.tsx';
const zoomLevels: CalendarTypes.CalendarZoomLevel[] = ['month', 'year', 'decade', 'century'];
const weekNumberRules: CalendarTypes.WeekNumberRule[] = ['auto', 'firstDay', 'firstFourDays', 'fullWeek'];
const weekDays: { id: number, text: string }[] = [
{ 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' },
];
const dateBoxLabel = { 'aria-label': 'Date' };
const zoomLevelLabel = { 'aria-label': 'Zoom Level' };
const dayLabel = { 'aria-label': 'First Day of Week' };
const ruleLabel = { 'aria-label': 'Week Number Rule' };
export default function App() {
const [zoomLevel, setZoomLevel] = useState<CalendarTypes.CalendarZoomLevel>('month');
const [currentValue, setCurrentValue] = useState<Date | undefined>(new Date());
const [useCellTemplate, setUseCellTemplate] = useState<boolean | null>(null);
const [disabled, setDisabled] = useState<boolean>(false);
const [showWeekNumbers, setShowWeekNumbers] = useState<boolean>(false);
const [firstDay, setFirstDay] = useState<CalendarTypes.DayOfWeek>(0);
const [weekNumberRule, setWeekNumberRule] = useState<CalendarTypes.WeekNumberRule>('auto');
const onCurrentValueChange = useCallback(
({ value }: { value?: Date }): void => {
setCurrentValue(value);
},
[],
);
const onDisabledChange = useCallback(
({ value }: CheckBoxTypes.ValueChangedEvent): void => {
setDisabled(value);
},
[],
);
const onZoomLevelChange = useCallback(
({ value }: Partial<SelectBoxTypes.ValueChangedEvent>): void => {
setZoomLevel(value);
},
[],
);
const onFirstDayChange = useCallback(
({ value }: SelectBoxTypes.ValueChangedEvent): void => {
setFirstDay(value);
},
[],
);
const onWeekNumberRuleChange = useCallback(
({ value }: SelectBoxTypes.ValueChangedEvent): void => {
setWeekNumberRule(value);
},
[],
);
const onShowWeekNumbersChange = useCallback(
({ value }: CheckBoxTypes.ValueChangedEvent): void => {
setShowWeekNumbers(value);
},
[setShowWeekNumbers],
);
const onUseCellTemplateChange = useCallback(
({ value }: CheckBoxTypes.ValueChangedEvent): void => {
setUseCellTemplate(!!value);
},
[setUseCellTemplate],
);
const onOptionChange = useCallback(
(e: CalendarTypes.OptionChangedEvent): void => {
if (e.name === 'zoomLevel') {
onZoomLevelChange({ value: e.value });
}
},
[onZoomLevelChange],
);
return (
<div id="calendar-demo">
<div className="calendar-container">
<Calendar
value={currentValue}
onValueChanged={onCurrentValueChange}
onOptionChanged={onOptionChange}
firstDayOfWeek={firstDay}
weekNumberRule={weekNumberRule}
showWeekNumbers={showWeekNumbers}
disabled={disabled}
zoomLevel={zoomLevel}
cellComponent={useCellTemplate ? CustomCell : undefined}
/>
</div>
<div className="options">
<div className="caption">Options</div>
<div className="option">
<span>Zoom level</span>
<SelectBox
dataSource={zoomLevels}
value={zoomLevel}
inputAttr={zoomLevelLabel}
onValueChanged={onZoomLevelChange}
/>
</div>
<div className="option">
<span>Selected date</span>
<DateBox
id="selected-date"
value={currentValue}
onValueChanged={onCurrentValueChange}
inputAttr={dateBoxLabel}
/>
</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="caption option">
<span>Week numeration</span>
</div>
<div className="option">
<CheckBox
defaultValue={false}
text="Show week numbers"
onValueChanged={onShowWeekNumbersChange}
/>
</div>
<div className="option">
<span>First day of week</span>
<SelectBox
dataSource={weekDays}
inputAttr={dayLabel}
displayExpr="text"
valueExpr="id"
value={firstDay}
onValueChanged={onFirstDayChange}
/>
</div>
<div className="option">
<span>Week number rule</span>
<SelectBox
dataSource={weekNumberRules}
inputAttr={ruleLabel}
value={weekNumberRule}
onValueChanged={onWeekNumberRuleChange}
/>
</div>
</div>
</div>
);
}
import React, { useCallback, useState } 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 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' },
];
const dateBoxLabel = { 'aria-label': 'Date' };
const zoomLevelLabel = { 'aria-label': 'Zoom Level' };
const dayLabel = { 'aria-label': 'First Day of Week' };
const ruleLabel = { 'aria-label': 'Week Number Rule' };
export default function App() {
const [zoomLevel, setZoomLevel] = useState('month');
const [currentValue, setCurrentValue] = useState(new Date());
const [useCellTemplate, setUseCellTemplate] = useState(null);
const [disabled, setDisabled] = useState(false);
const [showWeekNumbers, setShowWeekNumbers] = useState(false);
const [firstDay, setFirstDay] = useState(0);
const [weekNumberRule, setWeekNumberRule] = useState('auto');
const onCurrentValueChange = useCallback(({ value }) => {
setCurrentValue(value);
}, []);
const onDisabledChange = useCallback(({ value }) => {
setDisabled(value);
}, []);
const onZoomLevelChange = useCallback(({ value }) => {
setZoomLevel(value);
}, []);
const onFirstDayChange = useCallback(({ value }) => {
setFirstDay(value);
}, []);
const onWeekNumberRuleChange = useCallback(({ value }) => {
setWeekNumberRule(value);
}, []);
const onShowWeekNumbersChange = useCallback(
({ value }) => {
setShowWeekNumbers(value);
},
[setShowWeekNumbers],
);
const onUseCellTemplateChange = useCallback(
({ value }) => {
setUseCellTemplate(!!value);
},
[setUseCellTemplate],
);
const onOptionChange = useCallback(
(e) => {
if (e.name === 'zoomLevel') {
onZoomLevelChange({ value: e.value });
}
},
[onZoomLevelChange],
);
return (
<div id="calendar-demo">
<div className="calendar-container">
<Calendar
value={currentValue}
onValueChanged={onCurrentValueChange}
onOptionChanged={onOptionChange}
firstDayOfWeek={firstDay}
weekNumberRule={weekNumberRule}
showWeekNumbers={showWeekNumbers}
disabled={disabled}
zoomLevel={zoomLevel}
cellComponent={useCellTemplate ? CustomCell : undefined}
/>
</div>
<div className="options">
<div className="caption">Options</div>
<div className="option">
<span>Zoom level</span>
<SelectBox
dataSource={zoomLevels}
value={zoomLevel}
inputAttr={zoomLevelLabel}
onValueChanged={onZoomLevelChange}
/>
</div>
<div className="option">
<span>Selected date</span>
<DateBox
id="selected-date"
value={currentValue}
onValueChanged={onCurrentValueChange}
inputAttr={dateBoxLabel}
/>
</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="caption option">
<span>Week numeration</span>
</div>
<div className="option">
<CheckBox
defaultValue={false}
text="Show week numbers"
onValueChanged={onShowWeekNumbersChange}
/>
</div>
<div className="option">
<span>First day of week</span>
<SelectBox
dataSource={weekDays}
inputAttr={dayLabel}
displayExpr="text"
valueExpr="id"
value={firstDay}
onValueChanged={onFirstDayChange}
/>
</div>
<div className="option">
<span>Week number rule</span>
<SelectBox
dataSource={weekNumberRules}
inputAttr={ruleLabel}
value={weekNumberRule}
onValueChanged={onWeekNumberRuleChange}
/>
</div>
</div>
</div>
);
}
import React from 'react';
import type { CalendarTypes } from 'devextreme-react/calendar';
export function isWeekend(date: Date): boolean {
const day = date.getDay();
return day === 0 || day === 6;
}
const holidays: number[][] = [
[1, 0],
[4, 6],
[25, 11],
];
export function isHoliday(date: Date): boolean {
return holidays.some((item: number[]): boolean => date.getDate() === item[0] && date.getMonth() === item[1]);
}
function getCellCssClass({ date, view }: CalendarTypes.CellTemplateData): string {
let cssClass = '';
if (view === 'month') {
if (!date) {
cssClass = 'week-number';
} else {
if (isWeekend(date)) {
cssClass = 'weekend';
}
if (isHoliday(date)) {
cssClass = 'holiday';
}
}
}
return cssClass;
}
interface CustomCellProps {
data: CalendarTypes.CellTemplateData;
}
function CustomCell({ data: cell }: CustomCellProps) {
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.tsx';
ReactDOM.render(<App />, document.getElementById('app'));
import React from 'react';
export function isWeekend(date) {
const day = date.getDay();
return day === 0 || day === 6;
}
const holidays = [
[1, 0],
[4, 6],
[25, 11],
];
export function isHoliday(date) {
return holidays.some((item) => date.getDate() === item[0] && date.getMonth() === item[1]);
}
function getCellCssClass({ date, view }) {
let cssClass = '';
if (view === 'month') {
if (!date) {
cssClass = 'week-number';
} else {
if (isWeekend(date)) {
cssClass = 'weekend';
}
if (isHoliday(date)) {
cssClass = 'holiday';
}
}
}
return cssClass;
}
function CustomCell({ data: 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 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/26.1.5/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="./bundle.css" />
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"></div>
</div>
<script src="bundles/vendor/react.vendor.js"></script>
<script src="./bundle.js"></script>
</body>
</html>
#calendar-demo {
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;
}
When you add a Calendar to an application, you need to specify its value in one of the following formats:
-
Date
Specifies the date directly. -
Number
Specifies the date with a timestamp (total milliseconds since 1970/01/01). -
String
Specifies the date with 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, "2017-03-27T16:54:10+03")
-
Array of the formats mentioned before
Available only for 'multiple' and 'range' selection modes. The array includes all selected dates.
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.