JavaScript/jQuery TagBox - Accessibility

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.

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) {
  • // ...
  • });
  • }

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.