Vue CheckBox - Accessibility

Accessibility Features Overview

NOTE

The overall accessibility level of your application depends on the CheckBox features 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 CheckBox 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)	CheckBox 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 CheckBox component:

Key	Action
Space	Changes the UI component value.

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

jQuery

index.js

const checkBox = $('#checkBoxContainer').dxCheckBox('instance');

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

Angular

app.component.ts

import { ViewChild, AfterViewInit } from '@angular/core';
import { DxCheckBoxComponent } from 'devextreme-angular/ui/check-box';

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

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

Vue

Code

<template>
    <DxCheckBox ref="checkBoxRef" />
</template>

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

const checkBoxRef = ref<DxCheckBox | null>(null);

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

</script>

React

App.tsx

import React, { useRef, useEffect } from 'react';
import { CheckBox, type CheckBoxRef } from 'devextreme-react/check-box';

function App() {
    const checkBoxRef = useRef<CheckBoxRef>(null);

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

    return (
        <CheckBox ref={checkBoxRef} />
    );
}

Screen Reader Support

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

The CheckBox's aria label depends on the properties you use. If you specify the text or hint property, its value is copied to the aria-label. In other cases, use elementAttr to specify the aria-label directly.