Accessibility Features Overview
NOTE
The overall accessibility level of your application depends on the Switch 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 Switch 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 Switch component:
| Key | Action |
|---|---|
| Enter or Space | Changes the UI component value. |
| → | Changes the switch state to "On". |
| ← | Changes the switch state to "Off". |
Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.
jQuery
JavaScript
function registerKeyHandlers () {
const switch = $("#switchContainer").dxSwitch("instance");
switch.registerKeyHandler("backspace", function(e) {
// The argument "e" contains information on the event
});
switch.registerKeyHandler("space", function(e) {
// ...
});
}Angular
TypeScript
import { ..., ViewChild, AfterViewInit } from '@angular/core';
import { DxSwitchModule, DxSwitchComponent } from 'devextreme-angular';
// ...
export class AppComponent implements AfterViewInit {
@ViewChild(DxSwitchComponent, { static: false }) switch: DxSwitchComponent;
// Prior to Angular 8
// @ViewChild(DxSwitchComponent) switch: DxSwitchComponent;
ngAfterViewInit () {
this.switch.instance.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.switch.instance.registerKeyHandler('space', function(e) {
// ...
});
}
}
@NgModule({
imports: [
// ...
DxSwitchModule
],
// ...
})Vue
<template>
<DxSwitch :ref="mySwitchRef" />
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxSwitch from 'devextreme-vue/switch';
const mySwitchRef = 'my-switch';
export default {
components: {
DxSwitch
},
data() {
return {
mySwitchRef
}
},
computed: {
switch: function() {
return this.$refs[mySwitchRef].instance;
}
},
mounted: function() {
this.switch.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.switch.registerKeyHandler('space', function(e) {
// ...
});
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import { Switch } from 'devextreme-react/switch';
class App extends React.Component {
constructor(props) {
super(props);
this.switchRef = React.createRef();
}
render() {
return (
<Switch ref={this.switchRef} />
);
}
get switch() {
return this.switchRef.current.instance;
}
componentDidMount() {
this.switch.registerKeyHandler('backspace', function(e) {
// The argument "e" contains information on the event
});
this.switch.registerKeyHandler('space', function(e) {
// ...
});
}
}
export default App;Screen Reader Support
The Switch component supports screen readers and complies to WAI-ARIA standards.
Feedback