JavaScript/jQuery Toolbar - Accessibility

Accessibility Features Overview

NOTE

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

You can use the following keys to interact with the Toolbar component when allowKeyboardNavigation is set to true:

Key	Action
Tab / Shift + Tab	Moves focus to and away from the Toolbar. The first time users focus the Toolbar after initialization, the component highlights the first item. Subsequent focus events restore the previously highlighted item.
Left Arrow / Right Arrow	Moves focus to the previous or next available Toolbar item.
Up Arrow / Down Arrow	In the overflow menu, moves focus to the previous or next available Toolbar item. When a ButtonGroup item has focus in the toolbar, moves focus between the ButtonGroup items.
Home / End	Moves focus to the first or last available Toolbar item.
Enter / Space	Activates the focused Toolbar item.

This keyboard navigation behavior applies to standalone Toolbar instances, as well as instances embedded in DevExtreme components such as DataGrid, FileManager, and Gantt. You can modify this behavior to allow users to navigate between items with the Tab key. Disable allowKeyboardNavigation in a defaultOptions() call as follows:

jQuery

index.js

DevExpress.ui.dxToolbar.defaultOptions({
    options: {
        onInitialized(e) {
            if ($(e.element).closest('.dx-component-name').length) {
                e.component.option('allowKeyboardNavigation', false);
            }
        }
    }
})

Angular

app.component.ts

import dxToolbar from "devextreme/ui/toolbar";
import { type DxToolbarTypes } from "devextreme-angular/ui/toolbar";
// ...
export class AppComponent {
    constructor() {
        dxToolbar.defaultOptions({
            options: {
                onInitialized(e: DxToolbarTypes.InitializedEvent) {
                    if (e.element?.closest('.dx-component-name')) {
                        e.component?.option('allowKeyboardNavigation', false);
                    }
                }
            }
        })
    }
}

Vue

App.vue

<script setup lang="ts">
import dxToolbar from "devextreme/ui/toolbar";
import { type DxToolbarTypes } from "devextreme-vue/toolbar";

dxToolbar.defaultOptions({
    options: {
        onInitialized(e: DxToolbarTypes.InitializedEvent) {
            if (e.element?.closest('.dx-component-name')) {
                e.component?.option('allowKeyboardNavigation', false);
            }
        }
    }
});
</script>

React

App.tsx

import dxToolbar from "devextreme/ui/toolbar";
import { type ToolbarTypes } from "devextreme-react/toolbar";

dxToolbar.defaultOptions({
    options: {
        onInitialized(e: ToolbarTypes.InitializedEvent) {
            if (e.element?.closest('.dx-component-name')) {
                e.component?.option('allowKeyboardNavigation', false);
            }
        }
    }
});

Replace .dx-component-name with a component ID or class.

IMPORTANT

If you disable allowKeyboardNavigation, the Toolbar no longer follows the W3C ARIA APG Toolbar Pattern. Your application will be less accessible to users who rely on keyboard navigation.

Screen Reader Support

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