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 Button 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 Button component:
| Key | Action |
|---|---|
| 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 button = $("#buttonContainer").dxButton("instance");
button.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
button.registerKeyHandler("space", function(e) {
// ...
});
}Angular
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxButtonModule, DxButtonComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxButtonComponent, { static: false }) button: DxButtonComponent;
// Prior to Angular 8
// @ViewChild(DxButtonComponent) button: DxButtonComponent;
ngAfterViewInit () {
this.button.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxButtonModule
],
// ...
})Vue
<template>
<DxButton :ref="myButtonRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxButton from 'devextreme-vue/button';
const myButtonRef = 'my-button';
export default {
components: {
DxButton
},
data() {
return {
myButtonRef
}
},
computed: {
button: function() {
return this.$refs[myButtonRef].instance;
}
},
mounted: function() {
this.button.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import { Button } from 'devextreme-react/button';
class App extends React.Component {
constructor(props) {
super(props);
this.buttonRef = React.createRef();
}
render() {
return (
<Button ref={this.buttonRef} />
);
}
get button() {
return this.buttonRef.current.instance;
}
componentDidMount() {
this.button.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.button.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;Screen Reader Support
The Button component supports screen readers and complies to WAI-ARIA standards.
The 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.