Angular Switch - Accessibility

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 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)	Switch does not support Windows High Contrast themes.

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 Switch component:

Key	Action
Enter or Space	Changes the UI component value.
Right Arrow	Changes the switch state to "On".
Left Arrow	Changes the switch state to "Off".

Use the registerKeyHandler(key, handler) method to implement a custom handler for a key.

jQuery

index.js

const switch = $('#switchContainer').dxSwitch('instance');

switch.registerKeyHandler('backspace', function(e) {
    // The argument 'e' contains information about the event
});
switch.registerKeyHandler('space', function(e) {
    // ...
});

Angular

app.component.ts

import { ViewChild, AfterViewInit } from '@angular/core';
import { DxSwitchComponent } from 'devextreme-angular/ui/switch';

@Component({
    imports: [DxSwitchComponent],
    // ...
})
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 about the event
        });
        this.switch.instance.registerKeyHandler('space', function(e) {
            // ...
        });
    }
}

Vue

Code

<template>
    <DxSwitch ref="switchRef" />
</template>

<script setup lang="ts">
import { onMounted, ref } from 'vue';
import { DxSwitch } from 'devextreme-vue/switch';

const switchRef = ref<DxSwitch | null>(null);

onMounted(() => {
    switchRef.value.instance.registerKeyHandler('backspace', function(e) {
        // The argument "e" contains information about the event
    });
    switchRef.value.instance.registerKeyHandler('space', function(e) {
        // ...
    });
})

</script>

React

App.tsx

import React, { useRef, useEffect } from 'react';
import { Switch, type SwitchRef } from 'devextreme-react/switch';

function App() {
    const switchRef = useRef<SwitchRef>(null);

    useEffect(() => {
        const switch = switchRef.current.instance();
        switch.registerKeyHandler('backspace', function(e) {
            // The argument "e" contains information about the event
        });
        switch.registerKeyHandler('space', function(e) {
            // ...
        });
    }, []);

    return (
        <Switch ref={switchRef} />
    );
}

Screen Reader Support

The Switch component supports screen readers and complies to WAI-ARIA standards.