Mobile Accessibility

Improve this doc

This plugin exposes information on the status of various accessibility features of mobile operating systems, including, for example, whether a screen reader is running, invert colors is enabled, and the preferred scaling for text. It also allows an application to send a string to be spoken by the screen reader, or a command to stop the screen reader from speaking.

Repo: https://github.com/phonegap/phonegap-mobile-accessibility

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add phonegap-plugin-mobile-accessibility
   $ npm install --save @ionic-native/mobile-accessibility@4
   

2. Add this plugin to your app's module

Supported platforms

• Android Fire OS
• Android
• iOS
• Windows

Usage

import { MobileAccessibility } from '@ionic-native/mobile-accessibility';


constructor(private mobileAccessibility: MobileAccessibility) { }

...

if(this.mobileAccessibility.isScreenReaderRunningCallback();

Instance Members

MobileAccessibilityNotifications

isScreenReaderRunning()

Makes an asynchronous call to native MobileAccessibility to determine if a screen reader is running.

isVoiceOverRunning()

Platforms:iOS 

An iOS-specific proxy for the MobileAccessibility.isScreenReaderRunning method

isTalkBackRunning()

Platforms:Amazon Fire OS Android 

An Android/Amazon Fire OS-specific proxy for the MobileAccessibility.isScreenReaderRunning method.

isChromeVoxActive()

Platforms:Amazon Fire OS Android 

On Android, this method returns true if ChromeVox is active and properly initialized with access to the text to speech API in the WebView. If TalkBack is running but ChromeVox is not active, this method is useful to alert the user of a potential problem.

isBoldTextEnabled()

Platforms:iOS 

isClosedCaptioningEnabled()

isDarkerSystemColorsEnabled()

Platforms:iOS 

isGrayscaleEnabled()

Platforms:iOS 

isGuidedAccessEnabled()

Platforms:iOS 

isInvertColorsEnabled()

Platforms:iOS 

isMonoAudioEnabled()

Platforms:iOS 

isReduceMotionEnabled()

Platforms:iOS 

isReduceTransparencyEnabled()

Platforms:iOS 

isSpeakScreenEnabled()

Platforms:iOS 

isSpeakSelectionEnabled()

Platforms:iOS 

isSwitchControlRunning()

Platforms:iOS 

isTouchExplorationEnabled()

Platforms:Amazon Fire OS Android 

getTextZoom()

• @returns {Promise} Returns the result

setTextZoom(textZoom)

updateTextZoom()

usePreferredTextZoom(value)

A Boolean value which specifies whether to use the preferred text zoom of a default percent value of 100.

postNotification(mobileAccessibilityNotification, value)

Platforms:iOS 

Posts a notification with a string for the screen reader to announce if it is running.

speak(value, queueMode, properties)

Speaks a given string through the screenreader. On Android, if ChromeVox is active, it will use the specified queueMode and properties.

stop()

Stops speech.