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 ButtonGroup component complies to all Section 508 and WCAG 2.x standards criteria.
Keyboard Navigation
A user can use the following keys to interact with the ButtonGroup component:
| Key | Action |
|---|---|
| ← ↑ or PageUp | Moves focus to the previous button. |
| → ↓ or PageDown | Moves focus to the next button. |
| Home | Moves focus to the first button. |
| End | Moves focus to the last button. |
| Enter or Space | Identical to a click. |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
function registerKeyHandlers () {
const buttonGroup = $("#buttonGroupContainer").dxButtonGroup("instance");
buttonGroup.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
buttonGroup.registerKeyHandler("space", function(e) {
// ...
});
}Angular
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxButtonGroupModule, DxButtonGroupComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxButtonGroupComponent, { static: false }) buttonGroup: DxButtonGroupComponent;
// Prior to Angular 8
// @ViewChild(DxButtonGroupComponent) buttonGroup: DxButtonGroupComponent;
ngAfterViewInit () {
this.buttonGroup.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.buttonGroup.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxButtonGroupModule
],
// ...
})Vue
<template>
<DxButtonGroup :ref="myButtonGroupRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxButtonGroup from 'devextreme-vue/button-group';
const myButtonGroupRef = 'my-button-group';
export default {
components: {
DxButtonGroup
},
data() {
return {
myButtonGroupRef
}
},
computed: {
buttonGroup: function() {
return this.$refs[myButtonGroupRef].instance;
}
},
mounted: function() {
this.buttonGroup.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.buttonGroup.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import { ButtonGroup } from 'devextreme-react/button-group';
class App extends React.Component {
constructor(props) {
super(props);
this.buttonGroupRef = React.createRef();
}
render() {
return (
<ButtonGroup ref={this.buttonGroupRef} />
);
}
get buttonGroup() {
return this.buttonGroupRef.current.instance;
}
componentDidMount() {
this.buttonGroup.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.buttonGroup.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;Screen Reader Support
The ButtonGroup component supports screen readers and complies to WAI-ARIA standards.
Each button's aria label depends on the properties you use. If you specify the text property, its value is copied to the aria-label. If you do not specify text, but set the icon property, the icon can affect the aria label, depending on the value:
SVG
The content of thetitletag is copied to the aria label.DevExtreme icon, font icon
The icon name is copied to the aria label.Path to the icon file
The file name is copied to the aria label.
In other cases, use elementAttr to specify the aria-label directly.