See how Capacitor fits into the entire Ionic Ecosystem ->
Capacitor is part of the Ionic Ecosystem ->

@capacitor/screen-reader

The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.

Install

npm install @capacitor/screen-reader
npx cap sync

API

isEnabled()

isEnabled() => Promise<{ value: boolean; }>

Whether a Screen Reader is currently active.

This method is not supported on web (it is not possible to detect Screen Readers).

Returns: Promise<{ value: boolean; }>

Since: 1.0.0


speak(…)

speak(options: ScreenReaderSpeakOptions) => Promise<void>

Text-to-Speech functionality.

This function will only work if a Screen Reader is currently active.

On web, browsers must support the SpeechSynthesis API, or this method will throw an error.

For more text-to-speech capabilities, please see the Capacitor Community Text-to-Speech plugin.

Param Type
options ScreenReaderSpeakOptions

Since: 1.0.0


addListener(…)

addListener(eventName: 'screenReaderStateChange', listener: ScreenReaderStateChangeListener) => PluginListenerHandle

Add a listener

This method is not supported on web (it is not possible to detect Screen Readers).

Param Type
eventName "screenReaderStateChange"
listener (state: { value: boolean; }) => any

Returns: PluginListenerHandle

Since: 1.0.0


removeAllListeners()

removeAllListeners() => void

Remove all the listeners that are attached to this plugin.

Since: 1.0.0


Interfaces

ScreenReaderSpeakOptions

Prop Type Description Since
value string The text to speak. 1.0.0
language string The language to speak the text in, as its ISO 639-1 Code (e.g.: “en”). This option is only supported on Android. 1.0.0

PluginListenerHandle

Prop Type
remove () => void
Previous
<- Network
Next
Share ->