JavaScript/jQuery List - Accessibility

Accessibility Features Overview

NOTE

The overall accessibility level of your application depends on the List 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 List 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)	List does not support Windows High Contrast themes.
-	2.5.7 Dragging Movements (Level AA 2.2 only)	If itemDragging is enabled, the List component does not meet this criterion.
502.3.10 List of Actions 11.5.2.11 List of available actions	-	List does not supply information about the reorder and remove operations.

Keyboard Navigation

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

Key	Action
↑ / ↓	Moves focus to the previous/next item.
Page Up / Page Down	Moves focus to the item located a screen above/below the current one.
Home / End	Moves focus to the first/last item.
Enter or Space	Selects the focused item.
Shift + ↑ / ↓	Shifts the focused item one item up/down. Active if the allowItemReordering property is set to true.
Delete	Removes the focused item. Active if the allowItemDeleting property is set to true.

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

jQuery

JavaScript

function registerKeyHandlers () {
    const list = $("#listContainer").dxList("instance");
    list.registerKeyHandler("backspace", function(e) {
        // The argument "e" contains information on the event
    });
    list.registerKeyHandler("space", function(e) {
        // ...
    });
}

Angular

TypeScript

import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxListModule, DxListComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
    @ViewChild(DxListComponent, { static: false }) list: DxListComponent;
    // Prior to Angular 8
    // @ViewChild(DxListComponent) list: DxListComponent;

    ngAfterViewInit () {
        this.list.instance.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.list.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
@NgModule({
    imports: [
        // ...
        DxListModule
    ],
    // ...
})

Vue

<template>
    <DxList :ref="myListRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';

import DxList from 'devextreme-vue/list';

const myListRef = 'my-list';

export default {
    components: {
        DxList
    },
    data() {
        return {
            myListRef
        }
    },
    computed: {
        list: function() {
            return this.$refs[myListRef].instance;
        }
    },
    mounted: function() {
        this.list.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information on the event
        });
        this.list.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}
</script>

React

App.js

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import { List } from 'devextreme-react/list';

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

        this.listRef = React.createRef();
    }

    render() {
        return (
            <List ref={this.listRef} />
        );
    }

    get list() {
        return this.listRef.current.instance();
    }

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

export default App;

Screen Reader Support

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