Accessibility Features Overview
NOTE
The overall accessibility level of your application depends on the TagBox 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 TagBox 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) |
TagBox does not support Windows High Contrast themes. |
Keyboard Navigation
A user can use the following keys to interact with the TagBox component:
Key | Action |
---|---|
Alt + ↓ | Opens the drop-down list. |
Alt + ↑ | Closes the drop-down list. |
Esc | Closes the drop-down list and removes focus from the UI component. |
↑ / ↓ | Moves focus to the previous/next item. Active only when the drop-down list is open. |
Page Up / Page Down | Moves focus to the first/last currently rendered item. |
Enter or Space | Selects the current item. |
Backspace | Unselects the last selected item. |
← / → | Focuses the previous/following tag. |
Backspace / Delete | Removes focused tag. |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
JavaScript
function registerKeyHandlers () { const tagBox = $("#tagBoxContainer").dxTagBox("instance"); tagBox.registerKeyHandler("backspace", function(e) { // The argument "e" contains information on the event }); tagBox.registerKeyHandler("space", function(e) { // ... }); }
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core'; import { DxTagBoxModule, DxTagBoxComponent } from 'devextreme-angular'; // ... export class AppComponent implements AfterViewInit { @ViewChild(DxTagBoxComponent, { static: false }) tagBox: DxTagBoxComponent; // Prior to Angular 8 // @ViewChild(DxTagBoxComponent) tagBox: DxTagBoxComponent; ngAfterViewInit () { this.tagBox.instance.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.tagBox.instance.registerKeyHandler('space', function(e) { // ... }); } } @NgModule({ imports: [ // ... DxTagBoxModule ], // ... })
Vue
<template> <DxTagBox :ref="myTagBoxRef" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxTagBox from 'devextreme-vue/tag-box'; const myTagBoxRef = 'my-tag-box'; export default { components: { DxTagBox }, data() { return { myTagBoxRef } }, computed: { tagBox: function() { return this.$refs[myTagBoxRef].instance; } }, mounted: function() { this.tagBox.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.tagBox.registerKeyHandler('space', function(e) { // ... }); } } </script>
React
App.js
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { TagBox } from 'devextreme-react/tag-box'; class App extends React.Component { constructor(props) { super(props); this.tagBoxRef = React.createRef(); } render() { return ( <TagBox ref={this.tagBoxRef} /> ); } get tagBox() { return this.tagBoxRef.current.instance(); } componentDidMount() { this.tagBox.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.tagBox.registerKeyHandler('space', function(e) { // ... }); } } export default App;
Screen Reader Support
The TagBox component supports screen readers and complies to WAI-ARIA standards.
To improve accessibility, use the inputAttr property to specify aria-label for the component. You do not need to specify aria-label
if you use label.
Feedback