Vue ContextMenu - Accessibility

Accessibility Features Overview

NOTE

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

Key	Action
Left Arrow	Closes the submenu and focuses on its parent item.
Right Arrow	Opens the submenu of the focused item.
Home	Sets focus to the first item in the menu/submenu.
End	Sets focus to the last item in the menu/submenu.
Space	Switches the focused item to the selected state.
Enter	Chooses the focused item.

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

jQuery

index.js

const contextMenu = $('#contextMenuContainer').dxContextMenu('instance');

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

Angular

app.component.ts

import { ViewChild, AfterViewInit } from '@angular/core';
import { DxContextMenuComponent } from 'devextreme-angular/ui/context-menu';

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

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

Vue

Code

<template>
    <DxContextMenu ref="contextMenuRef" />
</template>

<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxContextMenu } from 'devextreme-vue/context-menu';

const contextMenuRef = ref<DxContextMenu | null>(null);

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

</script>

React

App.tsx

import React, { useRef, useEffect } from 'react';
import { ContextMenu, type ContextMenuRef } from 'devextreme-react/context-menu';

function App() {
    const contextMenuRef = useRef<ContextMenuRef>(null);

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

    return (
        <ContextMenu ref={contextMenuRef} />
    );
}

Screen Reader Support

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