{"_id":"@capacitor-geckoview/screen-reader","_rev":"4-2321b87cf5321a86949718d36cc38101","name":"@capacitor-geckoview/screen-reader","dist-tags":{"latest":"8.6.0"},"versions":{"8.0.1":{"name":"@capacitor-geckoview/screen-reader","version":"8.0.1","keywords":["capacitor","plugin","native"],"author":{"name":"Ionic","email":"hi@ionicframework.com"},"license":"MIT","_id":"@capacitor-geckoview/screen-reader@8.0.1","maintainers":[{"name":"wszgrcy","email":"wszgrcy@gmail.com"}],"homepage":"https://github.com/wszgrcy/capacitor-geckoview-plugins#readme","bugs":{"url":"https://github.com/wszgrcy/capacitor-geckoview-plugins/issues"},"dist":{"shasum":"bae6dd8b7a5d7a3d7744e3b11370d5118c500c09","tarball":"https://registry.npmjs.org/@capacitor-geckoview/screen-reader/-/screen-reader-8.0.1.tgz","fileCount":25,"integrity":"sha512-qQGiVdH2afugFws/SGax+82WF73Y8bmqDkVXCmWdE9I50QEp+L7OPSF3bGvfq/5icWiSTruu2Y+H/8dVuchIDQ==","signatures":[{"sig":"MEYCIQDrxpNLlMTwYp47hBU09/f7vaToUTe7FkkcGur2ip03bQIhAL0/NpNyjCwo1Dr/Yh9hPjflHqRCGwU/VpLoo4fBuIti","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":37112},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"4225aeb43b7250f2a81f07a7adee97b4b4b38bf5","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenReaderPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild build -scheme CapacitorScreenReader -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","publish:cocoapod":"pod trunk push ./CapacitorScreenReader.podspec --allow-warnings"},"_npmUser":{"name":"wszgrcy","email":"wszgrcy@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/wszgrcy/capacitor-geckoview-plugins.git","type":"git"},"_npmVersion":"11.12.1","description":"The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.","directories":{},"_nodeVersion":"24.15.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.1","rimraf":"^6.1.0","rollup":"^4.53.2","prettier":"^3.6.2","swiftlint":"^2.0.0","typescript":"^5.9.3","@capacitor/ios":"^8.0.0","@capacitor/core":"^8.0.0","@capacitor/docgen":"0.3.0","@capacitor/android":"^8.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.7.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/screen-reader_8.0.1_1788514815747_0.9870517133809815","host":"s3://npm-registry-packages-npm-production"}},"8.5.6":{"name":"@capacitor-geckoview/screen-reader","version":"8.5.6","keywords":["capacitor","plugin","native"],"author":{"name":"wszgrcy","email":"wszgrcy@gmail.com"},"license":"MIT","_id":"@capacitor-geckoview/screen-reader@8.5.6","maintainers":[{"name":"wszgrcy","email":"wszgrcy@gmail.com"}],"homepage":"https://github.com/wszgrcy/capacitor-geckoview-plugins#readme","bugs":{"url":"https://github.com/wszgrcy/capacitor-geckoview-plugins/issues"},"dist":{"shasum":"7c55d8a051c3f51f1a0c8f7f8451211e7657b729","tarball":"https://registry.npmjs.org/@capacitor-geckoview/screen-reader/-/screen-reader-8.5.6.tgz","fileCount":25,"integrity":"sha512-7WZiOHoianOpTapqnhOeITA2ninATGlwzCjEdpsv7YZBNtVGkJjegUpvgB3BL6D8AFTlNA5XJ1YHWNiyb2jofw==","signatures":[{"sig":"MEQCIHNIACTaRY5PXNhJSzEknnRKOXtkGKZrk1APHh+ZcCf/AiAdJmi1pdkfWIVybWfvxcpfUS15ghTwDLShqf1N2fY+dA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-geckoview%2fscreen-reader@8.5.6","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":37152},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"7b5d783b4736fa7ece909ce8d6f8360ba60b6868","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenReaderPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild build -scheme CapacitorScreenReader -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","publish:cocoapod":"pod trunk push ./CapacitorScreenReader.podspec --allow-warnings"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:362dc93e-ca22-4db9-b6f5-1a8b637a7d48"}},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/wszgrcy/capacitor-geckoview-plugins.git","type":"git"},"_npmVersion":"11.19.0","description":"The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.","directories":{},"_nodeVersion":"24.20.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.1","rimraf":"^6.1.0","rollup":"^4.53.2","prettier":"^3.6.2","swiftlint":"^2.0.0","typescript":"^5.9.3","@capacitor/ios":"^8.0.0","@capacitor/core":"^8.0.0","@capacitor/docgen":"0.3.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.7.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0","@capacitor-geckoview/android":"^8.0.0"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/screen-reader_8.5.6_1788531384028_0.49144189633546165","host":"s3://npm-registry-packages-npm-production"}},"8.5.7":{"name":"@capacitor-geckoview/screen-reader","version":"8.5.7","keywords":["capacitor","plugin","native"],"author":{"name":"wszgrcy","email":"wszgrcy@gmail.com"},"license":"MIT","_id":"@capacitor-geckoview/screen-reader@8.5.7","maintainers":[{"name":"wszgrcy","email":"wszgrcy@gmail.com"}],"homepage":"https://github.com/wszgrcy/capacitor-geckoview-plugins#readme","bugs":{"url":"https://github.com/wszgrcy/capacitor-geckoview-plugins/issues"},"dist":{"shasum":"0a2c80ce60e16240069e7671caa328ad09d502a7","tarball":"https://registry.npmjs.org/@capacitor-geckoview/screen-reader/-/screen-reader-8.5.7.tgz","fileCount":25,"integrity":"sha512-SOQdVa3da8kAk0Y6T1daTgvyaOHlOkmc04IvfmH9X6/stQWwH2NlCIBY54Y9AXG7cgOvkex2BFeujfyr7v59HQ==","signatures":[{"sig":"MEQCIBOVMDCuzrWGMBhcia2Ih8f7Nzy/Ro2DWC+ORbsOiOTPAiBoyvGGb4p6viWoGB//zDQ6bpOPxONFG5PopdWlmrl4UA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-geckoview%2fscreen-reader@8.5.7","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":37152},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"8b5461b659b8d1788d8b7058a1dc6743c53c769c","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenReaderPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","verify:ios":"xcodebuild build -scheme CapacitorScreenReader -destination generic/platform=iOS","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","publish:cocoapod":"pod trunk push ./CapacitorScreenReader.podspec --allow-warnings"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:362dc93e-ca22-4db9-b6f5-1a8b637a7d48"}},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/wszgrcy/capacitor-geckoview-plugins.git","type":"git"},"_npmVersion":"11.19.0","description":"The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.","directories":{},"_nodeVersion":"24.20.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.1","rimraf":"^6.1.0","rollup":"^4.53.2","prettier":"^3.6.2","swiftlint":"^2.0.0","typescript":"^5.9.3","@capacitor/ios":"^8.0.0","@capacitor/core":"^8.0.0","@capacitor/docgen":"0.3.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"^2.7.7","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0","@capacitor-geckoview/android":"^8.0.0"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/screen-reader_8.5.7_1788531808529_0.3944191656241949","host":"s3://npm-registry-packages-npm-production"}},"8.6.0":{"name":"@capacitor-geckoview/screen-reader","version":"8.6.0","description":"The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"wszgrcy","email":"wszgrcy@gmail.com"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/wszgrcy/capacitor-geckoview-plugins.git"},"bugs":{"url":"https://github.com/wszgrcy/capacitor-geckoview-plugins/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"xcodebuild build -scheme CapacitorScreenReader -destination generic/platform=iOS","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","docgen":"docgen --api ScreenReaderPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build","publish:cocoapod":"pod trunk push ./CapacitorScreenReader.podspec --allow-warnings"},"devDependencies":{"@capacitor/core":"^8.0.0","@capacitor/docgen":"0.3.0","@capacitor/ios":"^8.0.0","@ionic/eslint-config":"^0.4.0","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0","eslint":"^8.57.1","prettier":"^3.6.2","prettier-plugin-java":"^2.7.7","rimraf":"^6.1.0","rollup":"^4.53.2","swiftlint":"^2.0.0","typescript":"^5.9.3","@capacitor-geckoview/android":"^8.0.0"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"publishConfig":{"access":"public"},"gitHead":"01d4ce279e0b0b0c55b1b392db3f9a1b4673052e","_id":"@capacitor-geckoview/screen-reader@8.6.0","homepage":"https://github.com/wszgrcy/capacitor-geckoview-plugins#readme","_nodeVersion":"24.20.0","_npmVersion":"11.19.0","dist":{"integrity":"sha512-sw85Ev907kTiKW4/w3MQ8sSnbNwYfpXaqvpSmSNYUrAUI6cPgKsXA0EEbiXn8JXbZo5RcqvOVyBg9/RfAET4hA==","shasum":"71b96e765221030d2a67e0dd6ee3552b8784172b","tarball":"https://registry.npmjs.org/@capacitor-geckoview/screen-reader/-/screen-reader-8.6.0.tgz","fileCount":25,"unpackedSize":37152,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capacitor-geckoview%2fscreen-reader@8.6.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDJZoadpNJJOIP+2ddiXdVGQKVF+08zlxE80Wvi6+DG+AIgFazS74MrpO0ozfRPXctm3+5tAQLqAdOZBuqzSmaEu/Y="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:362dc93e-ca22-4db9-b6f5-1a8b637a7d48"}},"directories":{},"maintainers":[{"name":"wszgrcy","email":"wszgrcy@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/screen-reader_8.6.0_1788767323998_0.7760718955362329"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-04T09:40:15.631Z","modified":"2026-09-07T07:48:44.981Z","8.0.1":"2026-09-04T09:40:15.896Z","8.5.6":"2026-09-04T14:16:24.177Z","8.5.7":"2026-09-04T14:23:28.677Z","8.6.0":"2026-09-07T07:48:44.118Z"},"bugs":{"url":"https://github.com/wszgrcy/capacitor-geckoview-plugins/issues"},"author":{"name":"wszgrcy","email":"wszgrcy@gmail.com"},"license":"MIT","homepage":"https://github.com/wszgrcy/capacitor-geckoview-plugins#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/wszgrcy/capacitor-geckoview-plugins.git"},"description":"The Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.","maintainers":[{"name":"wszgrcy","email":"wszgrcy@gmail.com"}],"readme":"# @capacitor/screen-reader\n\nThe Screen Reader API provides access to TalkBack/VoiceOver/etc. and provides simple text-to-speech capabilities for visual accessibility.\n\n## Install\n\n```bash\nnpm install @capacitor/screen-reader\nnpx cap sync\n```\n\n## Example\n\n```typescript\nimport { ScreenReader } from '@capacitor/screen-reader';\n\nScreenReader.addListener('stateChange', ({ value }) => {\n  console.log(`Screen reader is now ${value ? 'on' : 'off'}`);\n});\n\nconst checkScreenReaderEnabled = async () => {\n  const { value } = await ScreenReader.isEnabled();\n\n  console.log('Voice over enabled? ' + value);\n};\n\nconst sayHello = async () => {\n  await ScreenReader.speak({ value: 'Hello World!' });\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`isEnabled()`](#isenabled)\n* [`speak(...)`](#speak)\n* [`addListener('stateChange', ...)`](#addlistenerstatechange-)\n* [`removeAllListeners()`](#removealllisteners)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### isEnabled()\n\n```typescript\nisEnabled() => Promise<{ value: boolean; }>\n```\n\nWhether a Screen Reader is currently active.\n\nThis method is not supported on web (it is not possible to detect Screen\nReaders).\n\n**Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### speak(...)\n\n```typescript\nspeak(options: SpeakOptions) => Promise<void>\n```\n\nText-to-Speech functionality.\n\nThis function will only work if a Screen Reader is currently active.\n\nOn web, browsers must support the [SpeechSynthesis\nAPI](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis), or\nthis method will throw an error.\n\nFor more text-to-speech capabilities, please see the [Capacitor Community\nText-to-Speech\nplugin](https://github.com/capacitor-community/text-to-speech).\n\n| Param         | Type                                                  |\n| ------------- | ----------------------------------------------------- |\n| **`options`** | <code><a href=\"#speakoptions\">SpeakOptions</a></code> |\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### addListener('stateChange', ...)\n\n```typescript\naddListener(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle>\n```\n\nAdd a listener for when the screen reader is turned on or off.\n\nThis event used to be named `'accessibilityScreenReaderStateChange'`.\n\nThis method is not supported on web (it is not possible to detect Screen\nReaders).\n\n| Param           | Type                                                                |\n| --------------- | ------------------------------------------------------------------- |\n| **`eventName`** | <code>'stateChange'</code>                                          |\n| **`listener`**  | <code><a href=\"#statechangelistener\">StateChangeListener</a></code> |\n\n**Returns:** <code>Promise&lt;<a href=\"#pluginlistenerhandle\">PluginListenerHandle</a>&gt;</code>\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### removeAllListeners()\n\n```typescript\nremoveAllListeners() => Promise<void>\n```\n\nRemove all the listeners that are attached to this plugin.\n\n**Since:** 1.0.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### SpeakOptions\n\n| Prop           | Type                | Description                                                                                                                                                               | Since |\n| -------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |\n| **`value`**    | <code>string</code> | The text to speak.                                                                                                                                                        | 1.0.0 |\n| **`language`** | <code>string</code> | The language to speak the text in, as its [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g.: \"en\"). This option is only supported on Android. | 1.0.0 |\n\n\n#### PluginListenerHandle\n\n| Prop         | Type                                      |\n| ------------ | ----------------------------------------- |\n| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |\n\n\n#### ScreenReaderState\n\n| Prop        | Type                 | Description                                  | Since |\n| ----------- | -------------------- | -------------------------------------------- | ----- |\n| **`value`** | <code>boolean</code> | Whether a Screen Reader is currently active. | 1.0.0 |\n\n\n### Type Aliases\n\n\n#### StateChangeListener\n\n<code>(state: <a href=\"#screenreaderstate\">ScreenReaderState</a>): void</code>\n\n</docgen-api>\n","readmeFilename":"README.md"}