All docs
V24.2
24.2
24.1
23.2
23.1
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.

JavaScript/jQuery Accordion - Accessibility

Accessibility Features Overview

NOTE
The overall accessibility level of your application depends on the Accordion 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 Accordion 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)
Accordion does not support Windows High Contrast themes.
501 (Web)(Software)
504.2 (Authoring Tool)
602.3 (Support Docs)
2.4.3 Focus Order (Level A) Accordion has an unexpected navigation order if there are interactive elements within the content.
501 (Web)(Software)
504.2 (Authoring Tool)
602.3 (Support Docs)
4.1.2 Name, Role, Value (Level A) Accordion does not supply information about the nested interactive elements.
11.5.2.5 Object information - Accordion does not supply information about the open and closed elements.

Keyboard Navigation

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

Key Action
↑ or PageUp Sets focus to the previous panel.
↓ or PageDown Sets focus to the next panel.
Home Sets focus to the first panel.
End Sets focus to the last panel.
Enter Expands the focused panel.
Space Collapses the focused panel.

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

jQuery
JavaScript
function registerKeyHandlers () {
    const accordion = $("#accordionContainer").dxAccordion("instance");
    accordion.registerKeyHandler("backspace", function(e) {
        // The argument "e" contains information on the event
    });
    accordion.registerKeyHandler("space", function(e) {
        // ...
    });
}
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxAccordionModule, DxAccordionComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
    @ViewChild(DxAccordionComponent, { static: false }) accordion: DxAccordionComponent;
    // Prior to Angular 8
    // @ViewChild(DxAccordionComponent) accordion: DxAccordionComponent;

    ngAfterViewInit () {
        this.accordion.instance.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.accordion.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
@NgModule({
    imports: [
        // ...
        DxAccordionModule
    ],
    // ...
})
Vue
<template>
    <DxAccordion :ref="myAccordionRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';

import DxAccordion from 'devextreme-vue/accordion';

const myAccordionRef = 'my-accordion';

export default {
    components: {
        DxAccordion
    },
    data() {
        return {
            myAccordionRef
        }
    },
    computed: {
        accordion: function() {
            return this.$refs[myAccordionRef].instance;
        }
    },
    mounted: function() {
        this.accordion.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.accordion.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
</script>
React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import { Accordion } from 'devextreme-react/accordion';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.accordionRef = React.createRef();
    }

    render() {
        return (
            <Accordion ref={this.accordionRef} />
        );
    }

    get accordion() {
        return this.accordionRef.current.instance();
    }

    componentDidMount() {
        this.accordion.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.accordion.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}

export default App;

Screen Reader Support

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