JavaScript/jQuery 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.

App.js
  • import React from 'react';
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import { Popup } from 'devextreme-react/popup';
  •  
  • class App extends React.Component {
  • constructor(props) {
  • super(props);
  •  
  • this.popupRef = React.createRef();
  • }
  •  
  • render() {
  • return (
  • <Popup ref={this.popupRef} />
  • );
  • }
  •  
  • get popup() {
  • return this.popupRef.current.instance;
  • }
  •  
  • componentDidMount() {
  • this.popup.registerKeyHandler('backspace', function(e) {
  • // The argument "e" contains information on the event
  • });
  • this.popup.registerKeyHandler('space', function(e) {
  • // ...
  • });
  • }
  • }
  •  
  • export default App;

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:

App.js
  • import React from 'react';
  • import Popup from 'devextreme-react/popup';
  •  
  • const onShowingHandler = (e) => {
  • const overlayContent = e.component.content().parentElement;
  • overlayContent.setAttribute('aria-modal', 'true');
  • };
  •  
  • const App = () => {
  • return (
  • <Popup ...
  • onShowing={onShowingHandler}
  • />
  • );
  • };
  •  
  • export default App;

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

App.js
  • import React from 'react';
  • import Popup from 'devextreme-react/popup';
  •  
  • const onShowingHandler = (e) => {
  • const overlayContent = e.component.content().parentElement;
  • overlayContent.setAttribute("aria-label", "Dialog window");
  • };
  •  
  • const App = () => {
  • return (
  • <Popup ...
  • onShowing={onShowingHandler}
  • />
  • );
  • };
  •  
  • export default App;