React NumberBox - Accessibility

Accessibility Features Overview

NOTE
The overall accessibility level of your application depends on the NumberBox 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 NumberBox 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)		 NumberBox does not support Windows High Contrast themes.
- 2.5.8 Target Size (Minimum) (Level AA 2.2 only) A spin button.

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 NumberBox component:

Key Action
Up Arrow or mouse wheel up Increases the UI component value by a step.
Down Arrow or mouse wheel down Decreases the UI component value by a step.

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

jQuery
index.js
const numberBox = $('#numberBoxContainer').dxNumberBox('instance');

numberBox.registerKeyHandler('backspace', function(e) {
    // The argument 'e' contains information about the event
});
numberBox.registerKeyHandler('space', function(e) {
    // ...
});
Angular
app.component.ts
import { ViewChild, AfterViewInit } from '@angular/core';
import { DxNumberBoxComponent } from 'devextreme-angular/ui/number-box';

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

    ngAfterViewInit () {
        this.numberBox.instance.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information about the event
        });
        this.numberBox.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
Vue
Code
<template>
    <DxNumberBox ref="numberBoxRef" />
</template>

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

const numberBoxRef = ref<DxNumberBox | null>(null);

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

</script>
React
App.tsx
import React, { useRef, useEffect } from 'react';
import { NumberBox, type NumberBoxRef } from 'devextreme-react/number-box';

function App() {
    const numberBoxRef = useRef<NumberBoxRef>(null);

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

    return (
        <NumberBox ref={numberBoxRef} />
    );
}

Screen Reader Support

The NumberBox 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.