Angular DateRangeBox - Accessibility

Accessibility Features Overview

NOTE

The overall accessibility level of your application depends on the DateRangeBox features that you use.

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 DateRangeBox 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)	DateRangeBox 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 DateRangeBox component:

Value Picker Type	Key	Action
Input Field	Alt + Down Arrow	Opens the date/time picker.
Input Field	Alt + Up Arrow / Esc	Closes the date/time picker.
Calendar	Arrow Keys	Moves focus to the day nearby.
	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.
	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.

Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.

jQuery

index.js

const dateRangeBox = $('#dateRangeBoxContainer').dxDateRangeBox('instance');

dateRangeBox.registerKeyHandler('backspace', function(e) {
    // The argument 'e' contains information about the event
});
dateRangeBox.registerKeyHandler('space', function(e) {
    // ...
});

Angular

app.component.ts

import { ViewChild, AfterViewInit } from '@angular/core';
import { DxDateRangeBoxComponent } from 'devextreme-angular/ui/date-range-box';

@Component({
    imports: [DxDateRangeBoxComponent],
    // ...
})
export class AppComponent implements AfterViewInit {
    @ViewChild(DxDateRangeBoxComponent, { static: false }) dateRangeBox!: DxDateRangeBoxComponent;
    // Prior to Angular 8
    // @ViewChild(DxDateRangeBoxComponent) dateRangeBox: DxDateRangeBoxComponent;

    ngAfterViewInit () {
        this.dateRangeBox.instance.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information about the event
        });
        this.dateRangeBox.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}

Vue

Code

<template>
    <DxDateRangeBox ref="dateRangeBoxRef" />
</template>

<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxDateRangeBox } from 'devextreme-vue/date-range-box';

const dateRangeBoxRef = ref<DxDateRangeBox | null>(null);

onMounted(() => {
    dateRangeBoxRef.value.instance.registerKeyHandler('backspace', function(e) {
        // The argument "e" contains information about the event
    });
    dateRangeBoxRef.value.instance.registerKeyHandler('space', function(e) {
        // ...
    });
})

</script>

React

App.tsx

import React, { useRef, useEffect } from 'react';
import { DateRangeBox, type DateRangeBoxRef } from 'devextreme-react/date-range-box';

function App() {
    const dateRangeBoxRef = useRef<DateRangeBoxRef>(null);

    useEffect(() => {
        const dateRangeBox = dateRangeBoxRef.current.instance();
        dateRangeBox.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information about the event
        });
        dateRangeBox.registerKeyHandler('space', function(e) {
            // ...
        });
    }, []);

    return (
        <DateRangeBox ref={dateRangeBoxRef} />
    );
}

Screen Reader Support

The DateRangeBox component supports screen readers and complies to WAI-ARIA standards.

To improve accessibility, use the startDateInputAttr and endDateInputAttr properties to specify aria-label for the component. You do not need to specify aria-label if you use startDateLabel or endDateLabel correspondingly.