AccessibilityPlugin

isScreenReaderEnabled

isScreenReaderEnabled(): Promise<ScreenReaderEnabledResult>
Check if a screen reader is enabled on the device
Returns: Promise<ScreenReaderEnabledResult>

speak

speak(options: AccessibilitySpeakOptions): Promise<void>
Speak a string with a connected screen reader.
options AccessibilitySpeakOptions
Returns: Promise<void>

addListener

addListener(eventName: "accessibilityScreenReaderStateChange", listenerFunc: ScreenReaderStateChangeCallback): PluginListenerHandle
Listen for screen reader state change (on/off)
eventName "accessibilityScreenReaderStateChange"
listenerFunc ScreenReaderStateChangeCallback
Returns: PluginListenerHandle

Interfaces Used

ScreenReaderEnabledResult

interface ScreenReaderEnabledResult {
value : boolean;
}

AccessibilitySpeakOptions

interface AccessibilitySpeakOptions {
// The language to speak the string in, as its [ISO 639-1 Code](https://www.loc.gov/standards/iso639-2/php/code_list.php) (ex: "en"). Currently only supported on Android.
language ?: string;
// The string to speak
value : string;
}

ScreenReaderStateChangeCallback

type alias ScreenReaderStateChangeCallback {
}