@capacitor/screen-reader 5.0.7-nightly-20231107T150458.0 → 5.0.7

package/README.md

@@ -14,7 +14,7 @@ npx cap sync
 ```typescript
 import { ScreenReader } from '@capacitor/screen-reader';
 
-ScreenReader.addListener('screenReaderStateChange', ({ value }) => {
+ScreenReader.addListener('stateChange', ({ value }) => {
   console.log(`Screen reader is now ${value ? 'on' : 'off'}`);
 });
 
@@ -93,7 +93,7 @@ plugin](https://github.com/capacitor-community/text-to-speech).
 ### addListener('stateChange', ...)
 
 ```typescript
-addListener(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle>
+addListener(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Add a listener for when the screen reader is turned on or off.
@@ -108,7 +108,7 @@ Readers).
 | **`eventName`** | <code>'stateChange'</code>                                          |
 | **`listener`**  | <code><a href="#statechangelistener">StateChangeListener</a></code> |
 
-**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
 
 **Since:** 1.0.0
 

package/android/build.gradle

@@ -15,7 +15,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.1.1'
+        classpath 'com.android.tools.build:gradle:8.0.0'
         if (System.getenv("CAP_PLUGIN_PUBLISH") == "true") {
             classpath 'io.github.gradle-nexus:publish-plugin:1.3.0'
         }
@@ -31,10 +31,10 @@ if (System.getenv("CAP_PLUGIN_PUBLISH") == "true") {
 
 android {
     namespace "com.capacitorjs.plugins.screenreader"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"

package/dist/docs.json

@@ -45,7 +45,7 @@
       },
       {
         "name": "addListener",
-        "signature": "(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle>",
+        "signature": "(eventName: 'stateChange', listener: StateChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
         "parameters": [
           {
             "name": "eventName",
@@ -58,7 +58,7 @@
             "type": "StateChangeListener"
           }
         ],
-        "returns": "Promise<PluginListenerHandle>",
+        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
         "tags": [
           {
             "name": "since",

package/dist/esm/definitions.d.ts

@@ -63,7 +63,7 @@ export interface ScreenReaderPlugin {
      *
      * @since 1.0.0
      */
-    addListener(eventName: 'stateChange', listener: StateChangeListener): Promise<PluginListenerHandle>;
+    addListener(eventName: 'stateChange', listener: StateChangeListener): Promise<PluginListenerHandle> & PluginListenerHandle;
     /**
      * Remove all the listeners that are attached to this plugin.
      *

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface SpeakOptions {\n  /**\n   * The text to speak.\n   *\n   * @since 1.0.0\n   */\n  value: string;\n\n  /**\n   * The language to speak the text in, as its [ISO 639-1\n   * Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g.: \"en\").\n   *\n   * This option is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  language?: string;\n}\n\nexport interface ScreenReaderState {\n  /**\n   * Whether a Screen Reader is currently active.\n   *\n   * @since 1.0.0\n   */\n  value: boolean;\n}\n\nexport type StateChangeListener = (state: ScreenReaderState) => void;\n\nexport interface ScreenReaderPlugin {\n  /**\n   * Whether a Screen Reader is currently active.\n   *\n   * This method is not supported on web (it is not possible to detect Screen\n   * Readers).\n   *\n   * @since 1.0.0\n   */\n  isEnabled(): Promise<{ value: boolean }>;\n\n  /**\n   * Text-to-Speech functionality.\n   *\n   * This function will only work if a Screen Reader is currently active.\n   *\n   * On web, browsers must support the [SpeechSynthesis\n   * API](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis), or\n   * this method will throw an error.\n   *\n   * For more text-to-speech capabilities, please see the [Capacitor Community\n   * Text-to-Speech\n   * plugin](https://github.com/capacitor-community/text-to-speech).\n   *\n   * @since 1.0.0\n   */\n  speak(options: SpeakOptions): Promise<void>;\n\n  /**\n   * Add a listener for when the screen reader is turned on or off.\n   *\n   * This event used to be named `'accessibilityScreenReaderStateChange'`.\n   *\n   * This method is not supported on web (it is not possible to detect Screen\n   * Readers).\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'stateChange',\n    listener: StateChangeListener,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all the listeners that are attached to this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @deprecated Use `SpeakOptions`.\n * @since 1.0.0\n */\nexport type AccessibilitySpeakOptions = SpeakOptions;\n\n/**\n * @deprecated Use `StateChangeListener`.\n * @since 1.0.0\n */\nexport type ScreenReaderStateChangeCallback = StateChangeListener;\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface SpeakOptions {\n  /**\n   * The text to speak.\n   *\n   * @since 1.0.0\n   */\n  value: string;\n\n  /**\n   * The language to speak the text in, as its [ISO 639-1\n   * Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g.: \"en\").\n   *\n   * This option is only supported on Android.\n   *\n   * @since 1.0.0\n   */\n  language?: string;\n}\n\nexport interface ScreenReaderState {\n  /**\n   * Whether a Screen Reader is currently active.\n   *\n   * @since 1.0.0\n   */\n  value: boolean;\n}\n\nexport type StateChangeListener = (state: ScreenReaderState) => void;\n\nexport interface ScreenReaderPlugin {\n  /**\n   * Whether a Screen Reader is currently active.\n   *\n   * This method is not supported on web (it is not possible to detect Screen\n   * Readers).\n   *\n   * @since 1.0.0\n   */\n  isEnabled(): Promise<{ value: boolean }>;\n\n  /**\n   * Text-to-Speech functionality.\n   *\n   * This function will only work if a Screen Reader is currently active.\n   *\n   * On web, browsers must support the [SpeechSynthesis\n   * API](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis), or\n   * this method will throw an error.\n   *\n   * For more text-to-speech capabilities, please see the [Capacitor Community\n   * Text-to-Speech\n   * plugin](https://github.com/capacitor-community/text-to-speech).\n   *\n   * @since 1.0.0\n   */\n  speak(options: SpeakOptions): Promise<void>;\n\n  /**\n   * Add a listener for when the screen reader is turned on or off.\n   *\n   * This event used to be named `'accessibilityScreenReaderStateChange'`.\n   *\n   * This method is not supported on web (it is not possible to detect Screen\n   * Readers).\n   *\n   * @since 1.0.0\n   */\n  addListener(\n    eventName: 'stateChange',\n    listener: StateChangeListener,\n  ): Promise<PluginListenerHandle> & PluginListenerHandle;\n\n  /**\n   * Remove all the listeners that are attached to this plugin.\n   *\n   * @since 1.0.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @deprecated Use `SpeakOptions`.\n * @since 1.0.0\n */\nexport type AccessibilitySpeakOptions = SpeakOptions;\n\n/**\n * @deprecated Use `StateChangeListener`.\n * @since 1.0.0\n */\nexport type ScreenReaderStateChangeCallback = StateChangeListener;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capacitor/screen-reader",
-  "version": "5.0.7-nightly-20231107T150458.0",
+  "version": "5.0.7",
   "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",
@@ -79,5 +79,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dd8f5d2789fe8c9e15f1fdf7c95812b7b0af8a3d"
+  "gitHead": "c5aab483fe0609ab1b2503c245a6c27b6cfd5a7b"
 }