React Popup - Accessibility

Accessibility Features Overview

NOTE
The overall accessibility level of your application depends on the Popup 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 Popup component complies to all Section 508 and WCAG 2.x standards criteria.

Keyboard Navigation

A user can use the following keys to interact with the Popup component:

Key Action
↑ → ↓ ← Drags the popup when it is focused and dragEnabled is true.
Esc Closes the popup.

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

JavaScript
  • function registerKeyHandlers () {
  • const popup = $("#popupContainer").dxPopup("instance");
  • popup.registerKeyHandler("backspace", function(e) {
  • // The argument "e" contains information on the event
  • });
  • popup.registerKeyHandler("space", function(e) {
  • // ...
  • });
  • }

Screen Reader Support

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

The default Popup ARIA role is the non-modal dialog. If you use Popup as a modal, enable the aria-modal attribute as follows:

index.js
  • const popup = $('#popup').dxPopup({
  • // ...
  • onShowing: function (e) {
  • var $overlayContent = $(e.component.content()).parent()
  • $overlayContent.attr("aria-modal", "true");
  • },
  • }).dxPopup('instance');

You can also use this method to specify aria-label for the component:

index.js
  • const popup = $('#popup').dxPopup({
  • // ...
  • onShowing: function (e) {
  • var $overlayContent = $(e.component.content()).parent()
  • $overlayContent.attr("aria-label", "Dialog window");
  • },
  • }).dxPopup('instance');