Angular DropDownButton - Accessibility

Accessibility Features Overview

NOTE

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

Key	Action
Left Arrow	Moves focus to the action button when splitButton is enabled.
Right Arrow	Moves focus to the toggle button when splitButton is enabled.
Enter / Space	Identical to a click.
Enter / Space	Selects a menu item when focused.
Up Arrow / Down Arrow/td>	Moves focus to the previous/following menu item.
Down Arrow	Opens the drop-down menu.
Esc	Closes the drop-down menu.
Page Up / Page Down	Moves focus to the first/last menu item on the page.
Home / End	Moves focus to the first/last menu item.

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

jQuery

index.js

const dropDownButton = $('#dropDownButtonContainer').dxDropDownButton('instance');

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

Angular

app.component.ts

import { ViewChild, AfterViewInit } from '@angular/core';
import { DxDropDownButtonComponent } from 'devextreme-angular/ui/drop-down-button';

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

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

Vue

Code

<template>
    <DxDropDownButton ref="dropDownButtonRef" />
</template>

<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxDropDownButton } from 'devextreme-vue/drop-down-button';

const dropDownButtonRef = ref<DxDropDownButton | null>(null);

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

</script>

React

App.tsx

import React, { useRef, useEffect } from 'react';
import { DropDownButton, type DropDownButtonRef } from 'devextreme-react/drop-down-button';

function App() {
    const dropDownButtonRef = useRef<DropDownButtonRef>(null);

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

    return (
        <DropDownButton ref={dropDownButtonRef} />
    );
}

Screen Reader Support

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