Accessibility Features Overview
NOTE
The overall accessibility level of your application depends on the ColorBox 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 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. |
- | 2.5.8 Target Size (Minimum) (Level AA 2.2 only) | A drop-down button, handlers of alpha channel, and hue scale in ColorBox. |
Keyboard Navigation
A user can use the following keys to interact with the ColorBox component:
Key | Action |
---|---|
← → ↑ ↓ | Moves the color pointer. |
Ctrl + ↑ | Moves the RGB slider up. |
Ctrl + ↓ | Moves the RGB slider down. |
Ctrl + ← | Moves the transparency slider left. |
Ctrl + → | Moves the transparency slider right. |
Enter | Selects the color. |
Alt + ↑ | Opens the drop-down editor. |
Alt + ↓ or Esc | Closes the drop-down editor. |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
JavaScript
function registerKeyHandlers () { const colorBox = $("#colorBoxContainer").dxColorBox("instance"); colorBox.registerKeyHandler("backspace", function(e) { // The argument "e" contains information on the event }); colorBox.registerKeyHandler("space", function(e) { // ... }); }
Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core'; import { DxColorBoxModule, DxColorBoxComponent } from 'devextreme-angular'; // ... 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 on the event }); this.colorBox.instance.registerKeyHandler('space', function(e) { // ... }); } } @NgModule({ imports: [ // ... DxColorBoxModule ], // ... })
Vue
<template> <DxColorBox :ref="myColorBoxRef" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxColorBox from 'devextreme-vue/color-box'; const myColorBoxRef = 'my-color-box'; export default { components: { DxColorBox }, data() { return { myColorBoxRef } }, computed: { colorBox: function() { return this.$refs[myColorBoxRef].instance; } }, mounted: function() { this.colorBox.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.colorBox.registerKeyHandler('space', function(e) { // ... }); } } </script>
React
App.js
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { ColorBox } from 'devextreme-react/color-box'; class App extends React.Component { constructor(props) { super(props); this.colorBoxRef = React.createRef(); } render() { return ( <ColorBox ref={this.colorBoxRef} /> ); } get colorBox() { return this.colorBoxRef.current.instance(); } componentDidMount() { this.colorBox.registerKeyHandler('backspace', function(e) { // The argument "e" contains information on the event }); this.colorBox.registerKeyHandler('space', function(e) { // ... }); } } export default App;
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.
Feedback