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 ColorBox 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) |
ColorBox does not support Windows High Contrast themes. |
| 11.5.2.13 Tracking of focus and selection attributes | 2.4.3 Focus Order (Level A) | The ColorBox component does not meet this criterion. |
| 501 (Web)(Software) 504.2 (Authoring Tool) 602.3 (Support Docs) |
2.4.7 Focus Visible (Level AA) | The ColorBox palette handle does not have a focus indicator. |
| - | 2.5.8 Target Size (Minimum) (Level AA 2.2 only) | A drop-down button, handlers of alpha channel, and hue scale in ColorBox. |
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 ColorBox component:
| Key | Action |
|---|---|
| Arrow Keys | Moves the color pointer. |
| Ctrl + Up Arrow | Moves the RGB slider up. |
| Ctrl + Down Arrow | Moves the RGB slider down. |
| Ctrl + Left Arrow | Moves the transparency slider left. |
| Ctrl + Right Arrow | Moves the transparency slider right. |
| Enter | Selects the color. |
| Alt + Up Arrow | Opens the drop-down editor. |
| Alt + Down Arrow or Esc | Closes the drop-down editor. |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
const colorBox = $('#colorBoxContainer').dxColorBox('instance');
colorBox.registerKeyHandler('backspace', function(e) {
// The argument 'e' contains information about the event
});
colorBox.registerKeyHandler('space', function(e) {
// ...
});Angular
import { ViewChild, AfterViewInit } from '@angular/core';
import { DxColorBoxComponent } from 'devextreme-angular/ui/color-box';
@Component({
imports: [DxColorBoxComponent],
// ...
})
export class AppComponent implements AfterViewInit {
@ViewChild(DxColorBoxComponent, { static: false }) colorBox!: DxColorBoxComponent;
// Prior to Angular 8
// @ViewChild(DxColorBoxComponent) colorBox: DxColorBoxComponent;
ngAfterViewInit () {
this.colorBox.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
this.colorBox.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}Vue
<template>
<DxColorBox ref="colorBoxRef" />
</template>
<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxColorBox } from 'devextreme-vue/color-box';
const colorBoxRef = ref<DxColorBox | null>(null);
onMounted(() => {
colorBoxRef.value.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
colorBoxRef.value.instance.registerKeyHandler('space', function(e) {
// ...
});
})
</script>React
import React, { useRef, useEffect } from 'react';
import { ColorBox, type ColorBoxRef } from 'devextreme-react/color-box';
function App() {
const colorBoxRef = useRef<ColorBoxRef>(null);
useEffect(() => {
const colorBox = colorBoxRef.current.instance();
colorBox.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information about the event
});
colorBox.registerKeyHandler('space', function(e) {
// ...
});
}, []);
return (
<ColorBox ref={colorBoxRef} />
);
}Screen Reader Support
The ColorBox component supports screen readers and complies to WAI-ARIA standards. Known exceptions are listed in the Accessibility Standards Compliance topic.
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.