Accessibility Features Overview
| 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. |
The component also complies with the European Accessibility Act (EAA) and Americans with Disabilities Act (ADA) directives.
Keyboard Navigation
A user can use the following keys to interact with the TagBox component:
| Key | Action |
|---|---|
| Alt + Down Arrow | Opens the drop-down list. |
| Alt + Up Arrow | Closes the drop-down list. |
| Esc | Closes the drop-down list and removes focus from the UI component. |
| Up Arrow / Down Arrow | 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. |
| Left Arrow / Right Arrow | 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
const tagBox = $('#tagBoxContainer').dxTagBox('instance');
tagBox.registerKeyHandler('backspace', function(e) {
// The argument 'e' contains information about the event
});
tagBox.registerKeyHandler('space', function(e) {
// ...
});Angular
import { ViewChild, AfterViewInit } from '@angular/core';
import { DxTagBoxComponent } from 'devextreme-angular/ui/tag-box';
@Component({
imports: [DxTagBoxComponent],
// ...
})
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 about the event
});
this.tagBox.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}Vue
<template>
<DxTagBox ref="tagBoxRef" />
</template>
<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxTagBox } from 'devextreme-vue/tag-box';
const tagBoxRef = ref<DxTagBox | null>(null);
onMounted(() => {
tagBoxRef.value.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
tagBoxRef.value.instance.registerKeyHandler('space', function(e) {
// ...
});
})
</script>React
import React, { useRef, useEffect } from 'react';
import { TagBox, type TagBoxRef } from 'devextreme-react/tag-box';
function App() {
const tagBoxRef = useRef<TagBoxRef>(null);
useEffect(() => {
const tagBox = tagBoxRef.current.instance();
tagBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
tagBox.registerKeyHandler('space', function(e) {
// ...
});
}, []);
return (
<TagBox ref={tagBoxRef} />
);
}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.