--- description: Capacitor plugin to interact with screen readers like VoiceOver and TalkBack, detect whether one is enabled, and post accessibility announcements. Supports Android, iOS, and the web. title: Capacitor Screen Reader Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/screen-reader.png --- [Skip to content ](#capacitor-screen-reader-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * Screen Reader [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Migrating from @capacitor/screen-reader ](#migrating-from-capacitorscreen-reader) * [ Changelog ](#changelog) * [ License ](#license) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Migrating from @capacitor/screen-reader ](#migrating-from-capacitorscreen-reader) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Screen Reader Plugin[ΒΆ](#capacitor-screen-reader-plugin "Permanent link") Capacitor plugin to interact with screen readers. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") * πŸ”Ž **Detection**: Check whether a screen reader (VoiceOver/TalkBack) is currently enabled. * πŸ“£ **Announcements**: Post accessibility announcements that are read out by the active screen reader. * πŸ”” **State changes**: Listen for changes to the enabled state of the screen reader. * πŸ–₯️ **Cross-platform**: Supports Android, iOS and the web. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. * 🀝 **Compatibility**: Works alongside the [Accessibility Preferences](https://capawesome.io/docs/sdks/capacitor/accessibility-preferences/) and [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/) plugins. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! > \[!NOTE\] This plugin does **not** perform text-to-speech. The `announce(...)` method posts an accessibility announcement that is only read out when a screen reader is active. If you are looking for real text-to-speech, use the [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/) plugin instead. ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-screen-reader` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-screen-reader [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") No additional configuration is required for this plugin. ### iOS[ΒΆ](#ios "Permanent link") No additional configuration is required for this plugin. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { ScreenReader } from '@capawesome/capacitor-screen-reader'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const announce = async () => { [](#%5F%5Fcodelineno-3-4) await ScreenReader.announce({ [](#%5F%5Fcodelineno-3-5) value: 'The item was added to your cart.', [](#%5F%5Fcodelineno-3-6) }); [](#%5F%5Fcodelineno-3-7)}; [](#%5F%5Fcodelineno-3-8) [](#%5F%5Fcodelineno-3-9)const isEnabled = async () => { [](#%5F%5Fcodelineno-3-10) const { enabled } = await ScreenReader.isEnabled(); [](#%5F%5Fcodelineno-3-11) return enabled; [](#%5F%5Fcodelineno-3-12)}; [](#%5F%5Fcodelineno-3-13) [](#%5F%5Fcodelineno-3-14)const addStateChangeListener = async () => { [](#%5F%5Fcodelineno-3-15) await ScreenReader.addListener('stateChange', event => { [](#%5F%5Fcodelineno-3-16) console.log('Screen reader enabled:', event.enabled); [](#%5F%5Fcodelineno-3-17) }); [](#%5F%5Fcodelineno-3-18)}; [](#%5F%5Fcodelineno-3-19) [](#%5F%5Fcodelineno-3-20)const removeAllListeners = async () => { [](#%5F%5Fcodelineno-3-21) await ScreenReader.removeAllListeners(); [](#%5F%5Fcodelineno-3-22)}; ` ## API[ΒΆ](#api "Permanent link") * [announce(...)](#announce) * [isEnabled()](#isenabled) * [addListener('stateChange', ...)](#addlistenerstatechange-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) ### announce(...)[ΒΆ](#announce "Permanent link") `[](#%5F%5Fcodelineno-4-1)announce(options: AnnounceOptions) => Promise ` Post an accessibility announcement to the active screen reader. This does **not** perform text-to-speech. It posts an announcement that is read out by the screen reader (VoiceOver/TalkBack) if one is active. For real text-to-speech, use the [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/)plugin instead. On the web, the announcement is made through a visually hidden `aria-live` region, so it is only read out if the user has a screen reader running. | Param | Type | | ----------- | ----------------------------------- | | **options** | [AnnounceOptions](#announceoptions) | **Since:** 0.1.0 --- ### isEnabled()[ΒΆ](#isenabled "Permanent link") `[](#%5F%5Fcodelineno-5-1)isEnabled() => Promise ` Check whether a screen reader is currently enabled. On Android, this refers to whether touch exploration (TalkBack) is enabled. On iOS, this refers to whether VoiceOver is running. Only available on Android and iOS. **Returns:** `Promise<[IsEnabledResult](#isenabledresult)>` **Since:** 0.1.0 --- ### addListener('stateChange', ...)[ΒΆ](#addlistenerstatechange "Permanent link") `[](#%5F%5Fcodelineno-6-1)addListener(eventName: 'stateChange', listenerFunc: (event: StateChangeEvent) => void) => Promise ` Listen for changes to the enabled state of the screen reader. The device is only observed while at least one listener is attached. Only available on Android and iOS. | Param | Type | | ---------------- | ------------------------------------------------------ | | **eventName** | 'stateChange' | | **listenerFunc** | (event: [StateChangeEvent](#statechangeevent)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 0.1.0 --- ### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-7-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### AnnounceOptions[ΒΆ](#announceoptions "Permanent link") | Prop | Type | Description | Since | | ------------ | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | **value** | string | The message to announce. | 0.1.0 | | **language** | string | The language of the message as a BCP 47 language tag. This helps the screen reader pronounce the message correctly. Only available on Android. | 0.1.0 | #### IsEnabledResult[ΒΆ](#isenabledresult "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | --------------------------------------------- | ----- | | **enabled** | boolean | Whether a screen reader is currently enabled. | 0.1.0 | #### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | #### StateChangeEvent[ΒΆ](#statechangeevent "Permanent link") | Prop | Type | Description | Since | | ----------- | ------- | --------------------------------------------- | ----- | | **enabled** | boolean | Whether a screen reader is currently enabled. | 0.1.0 | ## Migrating from `@capacitor/screen-reader`[ΒΆ](#migrating-from-capacitorscreen-reader "Permanent link") This plugin is a drop-in replacement for the official `@capacitor/screen-reader` plugin with a few naming changes: | @capacitor/screen-reader | Screen Reader | | ------------------------------- | ------------------------------- | | speak({ value, language }) | announce({ value, language }) | | isEnabled() | isEnabled() | | addListener('stateChange', ...) | addListener('stateChange', ...) | The `speak(...)` method has been renamed to `announce(...)` to make it clear that it posts an accessibility announcement to the active screen reader and does **not** perform text-to-speech. For real text-to-speech, use the [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/) plugin instead. ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-reader/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-reader/LICENSE). July 7, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/screen-reader/#article", "headline": "Capacitor Screen Reader Plugin", "name": "Capacitor Screen Reader Plugin", "description": "Capacitor plugin to interact with screen readers like VoiceOver and TalkBack, detect whether one is enabled, and post accessibility announcements. Supports Android, iOS, and the web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/screen-reader/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/screen-reader/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/screen-reader/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/screen-reader/#software", "name": "Capacitor Screen Reader Plugin", "description": "Capacitor plugin to interact with screen readers like VoiceOver and TalkBack, detect whether one is enabled, and post accessibility announcements. Supports Android, iOS, and the web.", "url": "https://capawesome.io/docs/sdks/capacitor/screen-reader/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} ```