Accessibility Features Overview
| Accessibility Requirement | Support Level |
|---|---|
| Right-to-Left Support | |
| Keyboard Navigation Support | |
| Screen Reader Support | |
| Contrast Color Theme | |
| Mobile Device Support | |
| Lighthouse Accessibility Validation | |
| Axe Accessibility Validation | |
| WAVE Accessibility Validation | |
| Section 508 Support | |
| WCAG 2.x Support |
- - All component features meet the requirement
- - Some component features may not meet the requirement
- - Accessibility requirement is not supported
Accessibility Standards Compliance
The DateBox component meets a variety of Section 508 and WCAG 2.x compliance standards. Known exceptions:
| Section 508 criteria | WCAG 2.x criteria | Exception description |
|---|---|---|
| 501 (Web)(Software) 504.2 (Authoring Tool) 602.3 (Support Docs) |
1.4.3 Contrast (Minimum) (Level AA) 1.4.11 Non-text Contrast (Level AA 2.1 and 2.2) |
DateBox does not support Windows High Contrast themes. |
The component also complies with the European Accessibility Act (EAA) and Americans with Disabilities Act (ADA) directives.
Keyboard Navigation
A user can use the following keys to interact with the DateBox component:
| Value Picker | Key | Action |
|---|---|---|
| All | Alt + Down Arrow / Alt + Up Arrow | Opens/closes the value picker. |
| Esc | Closes the date/time picker. | |
| A / P | Switches time to AM/PM respectively. | |
| Calendar | Arrow Keys | Moves focus to the nearest date. |
| Page Up or Ctrl + Left Arrow | Displays the previous month. | |
| Page Down or Ctrl + Right Arrow | Displays the next month. | |
| Enter | Selects the focused day. | |
| Alt + Up Arrow / Alt + Down Arrow | Opens/closes the drop-down editor. | |
| Esc | Closes the drop-down editor. | |
| Ctrl + Up Arrow | Increases zoomLevel. | |
| Ctrl + Down Arrow | Decreases zoomLevel. | |
| Home | Moves focus to the first date in the view. | |
| End | Moves focus to the last date in the view. | |
| List | Up Arrow / Down Arrow | Moves focus to the previous/next time value. |
| Enter | Selects the focused time value. | |
| Page Up / Page Down | Moves focus to the first/last value. |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
const dateBox = $('#dateBoxContainer').dxDateBox('instance');
dateBox.registerKeyHandler('backspace', function(e) {
// The argument 'e' contains information about the event
});
dateBox.registerKeyHandler('space', function(e) {
// ...
});Angular
import { ViewChild, AfterViewInit } from '@angular/core';
import { DxDateBoxComponent } from 'devextreme-angular/ui/date-box';
@Component({
imports: [DxDateBoxComponent],
// ...
})
export class AppComponent implements AfterViewInit {
@ViewChild(DxDateBoxComponent, { static: false }) dateBox!: DxDateBoxComponent;
// Prior to Angular 8
// @ViewChild(DxDateBoxComponent) dateBox: DxDateBoxComponent;
ngAfterViewInit () {
this.dateBox.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
this.dateBox.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}Vue
<template>
<DxDateBox ref="dateBoxRef" />
</template>
<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxDateBox } from 'devextreme-vue/date-box';
const dateBoxRef = ref<DxDateBox | null>(null);
onMounted(() => {
dateBoxRef.value.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
dateBoxRef.value.instance.registerKeyHandler('space', function(e) {
// ...
});
})
</script>React
import React, { useRef, useEffect } from 'react';
import { DateBox, type DateBoxRef } from 'devextreme-react/date-box';
function App() {
const dateBoxRef = useRef<DateBoxRef>(null);
useEffect(() => {
const dateBox = dateBoxRef.current.instance();
dateBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
dateBox.registerKeyHandler('space', function(e) {
// ...
});
}, []);
return (
<DateBox ref={dateBoxRef} />
);
}Screen Reader Support
The DateBox component supports screen readers and complies to WAI-ARIA standards.
To improve accessibility, use the inputAttr property to specify aria-label for the component. You do not need to specify aria-label if you use the label option.