Accessibility Features Overview
NOTE
The overall accessibility level of your application depends on the Menu 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 Menu 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) |
Menu does not support Windows High Contrast themes. |
Keyboard Navigation
A user can use the following keys to interact with the Menu component:
| Key | Action |
|---|---|
| ← | Moves focus to the previous item. Closes the submenu and focuses on its parent item. |
| → | Moves focus to the next item. Opens the submenu of the focused item. |
| ↑ | Moves focus to the previous item. |
| ↓ | Moves focus to the next 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. |
If you set adaptivityEnabled to true, the Menu acts as a TreeView.
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
JavaScript
function registerKeyHandlers () {
const menu = $("#menuContainer").dxMenu("instance");
menu.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
menu.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxMenuModule, DxMenuComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxMenuComponent, { static: false }) menu: DxMenuComponent;
// Prior to Angular 8
// @ViewChild(DxMenuComponent) menu: DxMenuComponent;
ngAfterViewInit () {
this.menu.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.menu.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxMenuModule
],
// ...
})Vue
<template>
<DxMenu :ref="myMenuRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxMenu from 'devextreme-vue/menu';
const myMenuRef = 'my-menu';
export default {
components: {
DxMenu
},
data() {
return {
myMenuRef
}
},
computed: {
menu: function() {
return this.$refs[myMenuRef].instance;
}
},
mounted: function() {
this.menu.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.menu.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import { Menu } from 'devextreme-react/menu';
class App extends React.Component {
constructor(props) {
super(props);
this.menuRef = React.createRef();
}
render() {
return (
<Menu ref={this.menuRef} />
);
}
get menu() {
return this.menuRef.current.instance();
}
componentDidMount() {
this.menu.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.menu.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;Screen Reader Support
The Menu component supports screen readers and complies to WAI-ARIA standards.
Feedback