@capawesome/capacitor-screen-reader 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/screenreader/classes/results/IsEnabledResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.screenreader.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.screenreader.interfaces.Result;
+
+public class IsEnabledResult implements Result {
+
+    private final boolean enabled;
+
+    public IsEnabledResult(boolean enabled) {
+        this.enabled = enabled;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("enabled", enabled);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/screenreader/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.screenreader.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/screenreader/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.screenreader.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/screenreader/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.screenreader.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/screenreader/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.screenreader.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}

package/dist/docs.json

@@ -0,0 +1,222 @@
+{
+  "api": {
+    "name": "ScreenReaderPlugin",
+    "slug": "screenreaderplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "announce",
+        "signature": "(options: AnnounceOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AnnounceOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Post an accessibility announcement to the active screen reader.\n\nThis does **not** perform text-to-speech. It posts an announcement that is\nread out by the screen reader (VoiceOver/TalkBack) if one is active. For\nreal text-to-speech, use the [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/)\nplugin instead.\n\nOn the web, the announcement is made through a visually hidden\n`aria-live` region, so it is only read out if the user has a screen reader\nrunning.",
+        "complexTypes": [
+          "AnnounceOptions"
+        ],
+        "slug": "announce"
+      },
+      {
+        "name": "isEnabled",
+        "signature": "() => Promise<IsEnabledResult>",
+        "parameters": [],
+        "returns": "Promise<IsEnabledResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether a screen reader is currently enabled.\n\nOn Android, this refers to whether touch exploration (TalkBack) is enabled.\nOn iOS, this refers to whether VoiceOver is running.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsEnabledResult"
+        ],
+        "slug": "isenabled"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'stateChange', listenerFunc: (event: StateChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'stateChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: StateChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Listen for changes to the enabled state of the screen reader.\n\nThe device is only observed while at least one listener is attached.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "StateChangeEvent"
+        ],
+        "slug": "addlistenerstatechange-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "AnnounceOptions",
+      "slug": "announceoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "'The item was added to your cart.'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The message to announce.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "language",
+          "tags": [
+            {
+              "text": "'en'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The language of the message as a BCP 47 language tag.\n\nThis helps the screen reader pronounce the message correctly.\n\nOnly available on Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "IsEnabledResult",
+      "slug": "isenabledresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a screen reader is currently enabled.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "StateChangeEvent",
+      "slug": "statechangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [
+            {
+              "text": "true",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether a screen reader is currently enabled.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,92 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface ScreenReaderPlugin {
+    /**
+     * 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.
+     *
+     * @since 0.1.0
+     */
+    announce(options: AnnounceOptions): Promise<void>;
+    /**
+     * 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.
+     *
+     * @since 0.1.0
+     */
+    isEnabled(): Promise<IsEnabledResult>;
+    /**
+     * 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.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'stateChange', listenerFunc: (event: StateChangeEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 0.1.0
+     */
+    removeAllListeners(): Promise<void>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface AnnounceOptions {
+    /**
+     * The message to announce.
+     *
+     * @example 'The item was added to your cart.'
+     * @since 0.1.0
+     */
+    value: 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.
+     *
+     * @example 'en'
+     * @since 0.1.0
+     */
+    language?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface IsEnabledResult {
+    /**
+     * Whether a screen reader is currently enabled.
+     *
+     * @example true
+     * @since 0.1.0
+     */
+    enabled: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface StateChangeEvent {
+    /**
+     * Whether a screen reader is currently enabled.
+     *
+     * @example true
+     * @since 0.1.0
+     */
+    enabled: boolean;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface ScreenReaderPlugin {\n  /**\n   * Post an accessibility announcement to the active screen reader.\n   *\n   * This does **not** perform text-to-speech. It posts an announcement that is\n   * read out by the screen reader (VoiceOver/TalkBack) if one is active. For\n   * real text-to-speech, use the [Speech Synthesis](https://capawesome.io/docs/sdks/capacitor/speech-synthesis/)\n   * plugin instead.\n   *\n   * On the web, the announcement is made through a visually hidden\n   * `aria-live` region, so it is only read out if the user has a screen reader\n   * running.\n   *\n   * @since 0.1.0\n   */\n  announce(options: AnnounceOptions): Promise<void>;\n  /**\n   * Check whether a screen reader is currently enabled.\n   *\n   * On Android, this refers to whether touch exploration (TalkBack) is enabled.\n   * On iOS, this refers to whether VoiceOver is running.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  isEnabled(): Promise<IsEnabledResult>;\n  /**\n   * Listen for changes to the enabled state of the screen reader.\n   *\n   * The device is only observed while at least one listener is attached.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'stateChange',\n    listenerFunc: (event: StateChangeEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 0.1.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface AnnounceOptions {\n  /**\n   * The message to announce.\n   *\n   * @example 'The item was added to your cart.'\n   * @since 0.1.0\n   */\n  value: string;\n  /**\n   * The language of the message as a BCP 47 language tag.\n   *\n   * This helps the screen reader pronounce the message correctly.\n   *\n   * Only available on Android.\n   *\n   * @example 'en'\n   * @since 0.1.0\n   */\n  language?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IsEnabledResult {\n  /**\n   * Whether a screen reader is currently enabled.\n   *\n   * @example true\n   * @since 0.1.0\n   */\n  enabled: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface StateChangeEvent {\n  /**\n   * Whether a screen reader is currently enabled.\n   *\n   * @example true\n   * @since 0.1.0\n   */\n  enabled: boolean;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { ScreenReaderPlugin } from './definitions';
+declare const ScreenReader: ScreenReaderPlugin;
+export * from './definitions';
+export { ScreenReader };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const ScreenReader = registerPlugin('ScreenReader', {
+    web: () => import('./web').then(m => new m.ScreenReaderWeb()),
+});
+export * from './definitions';
+export { ScreenReader };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,YAAY,GAAG,cAAc,CAAqB,cAAc,EAAE;IACtE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;CAC9D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { ScreenReaderPlugin } from './definitions';\n\nconst ScreenReader = registerPlugin<ScreenReaderPlugin>('ScreenReader', {\n  web: () => import('./web').then(m => new m.ScreenReaderWeb()),\n});\n\nexport * from './definitions';\nexport { ScreenReader };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,11 @@
+import { WebPlugin } from '@capacitor/core';
+import type { PluginListenerHandle } from '@capacitor/core';
+import type { AnnounceOptions, IsEnabledResult, ScreenReaderPlugin } from './definitions';
+export declare class ScreenReaderWeb extends WebPlugin implements ScreenReaderPlugin {
+    private static readonly errorValueMissing;
+    private liveRegion;
+    announce(options: AnnounceOptions): Promise<void>;
+    isEnabled(): Promise<IsEnabledResult>;
+    addListener(): Promise<PluginListenerHandle>;
+    private getLiveRegion;
+}

package/dist/esm/web.js

@@ -0,0 +1,42 @@
+import { WebPlugin } from '@capacitor/core';
+export class ScreenReaderWeb extends WebPlugin {
+    async announce(options) {
+        if (!options.value) {
+            throw new Error(ScreenReaderWeb.errorValueMissing);
+        }
+        const liveRegion = this.getLiveRegion();
+        // Clear first so that repeating the same message is announced again.
+        liveRegion.textContent = '';
+        window.setTimeout(() => {
+            liveRegion.textContent = options.value;
+        }, 100);
+    }
+    async isEnabled() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async addListener() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    getLiveRegion() {
+        if (!this.liveRegion) {
+            const liveRegion = document.createElement('div');
+            liveRegion.setAttribute('aria-live', 'polite');
+            liveRegion.setAttribute('aria-atomic', 'true');
+            liveRegion.setAttribute('role', 'status');
+            liveRegion.style.position = 'absolute';
+            liveRegion.style.width = '1px';
+            liveRegion.style.height = '1px';
+            liveRegion.style.margin = '-1px';
+            liveRegion.style.padding = '0';
+            liveRegion.style.border = '0';
+            liveRegion.style.overflow = 'hidden';
+            liveRegion.style.clip = 'rect(0, 0, 0, 0)';
+            liveRegion.style.whiteSpace = 'nowrap';
+            document.body.appendChild(liveRegion);
+            this.liveRegion = liveRegion;
+        }
+        return this.liveRegion;
+    }
+}
+ScreenReaderWeb.errorValueMissing = 'value must be provided.';
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAS5C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAK5C,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;QACxC,qEAAqE;QACrE,UAAU,CAAC,WAAW,GAAG,EAAE,CAAC;QAC5B,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YACrB,UAAU,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC;QACzC,CAAC,EAAE,GAAG,CAAC,CAAC;IACV,CAAC;IAED,KAAK,CAAC,SAAS;QACb,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,WAAW;QACf,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC,CAAC;IACtD,CAAC;IAEO,aAAa;QACnB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjD,UAAU,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC/C,UAAU,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YAC/C,UAAU,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC1C,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU,CAAC;YACvC,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YAC/B,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;YAChC,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC;YACjC,UAAU,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,CAAC;YAC/B,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC;YAC9B,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACrC,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,kBAAkB,CAAC;YAC3C,UAAU,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;YACvC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;;AA3CuB,iCAAiB,GAAG,yBAAyB,CAAC","sourcesContent":["import { WebPlugin } from '@capacitor/core';\nimport type { PluginListenerHandle } from '@capacitor/core';\n\nimport type {\n  AnnounceOptions,\n  IsEnabledResult,\n  ScreenReaderPlugin,\n} from './definitions';\n\nexport class ScreenReaderWeb extends WebPlugin implements ScreenReaderPlugin {\n  private static readonly errorValueMissing = 'value must be provided.';\n\n  private liveRegion: HTMLElement | undefined;\n\n  async announce(options: AnnounceOptions): Promise<void> {\n    if (!options.value) {\n      throw new Error(ScreenReaderWeb.errorValueMissing);\n    }\n    const liveRegion = this.getLiveRegion();\n    // Clear first so that repeating the same message is announced again.\n    liveRegion.textContent = '';\n    window.setTimeout(() => {\n      liveRegion.textContent = options.value;\n    }, 100);\n  }\n\n  async isEnabled(): Promise<IsEnabledResult> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  async addListener(): Promise<PluginListenerHandle> {\n    throw this.unimplemented('Not implemented on web.');\n  }\n\n  private getLiveRegion(): HTMLElement {\n    if (!this.liveRegion) {\n      const liveRegion = document.createElement('div');\n      liveRegion.setAttribute('aria-live', 'polite');\n      liveRegion.setAttribute('aria-atomic', 'true');\n      liveRegion.setAttribute('role', 'status');\n      liveRegion.style.position = 'absolute';\n      liveRegion.style.width = '1px';\n      liveRegion.style.height = '1px';\n      liveRegion.style.margin = '-1px';\n      liveRegion.style.padding = '0';\n      liveRegion.style.border = '0';\n      liveRegion.style.overflow = 'hidden';\n      liveRegion.style.clip = 'rect(0, 0, 0, 0)';\n      liveRegion.style.whiteSpace = 'nowrap';\n      document.body.appendChild(liveRegion);\n      this.liveRegion = liveRegion;\n    }\n    return this.liveRegion;\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,56 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const ScreenReader = core.registerPlugin('ScreenReader', {
+    web: () => Promise.resolve().then(function () { return web; }).then(m => new m.ScreenReaderWeb()),
+});
+
+class ScreenReaderWeb extends core.WebPlugin {
+    async announce(options) {
+        if (!options.value) {
+            throw new Error(ScreenReaderWeb.errorValueMissing);
+        }
+        const liveRegion = this.getLiveRegion();
+        // Clear first so that repeating the same message is announced again.
+        liveRegion.textContent = '';
+        window.setTimeout(() => {
+            liveRegion.textContent = options.value;
+        }, 100);
+    }
+    async isEnabled() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    async addListener() {
+        throw this.unimplemented('Not implemented on web.');
+    }
+    getLiveRegion() {
+        if (!this.liveRegion) {
+            const liveRegion = document.createElement('div');
+            liveRegion.setAttribute('aria-live', 'polite');
+            liveRegion.setAttribute('aria-atomic', 'true');
+            liveRegion.setAttribute('role', 'status');
+            liveRegion.style.position = 'absolute';
+            liveRegion.style.width = '1px';
+            liveRegion.style.height = '1px';
+            liveRegion.style.margin = '-1px';
+            liveRegion.style.padding = '0';
+            liveRegion.style.border = '0';
+            liveRegion.style.overflow = 'hidden';
+            liveRegion.style.clip = 'rect(0, 0, 0, 0)';
+            liveRegion.style.whiteSpace = 'nowrap';
+            document.body.appendChild(liveRegion);
+            this.liveRegion = liveRegion;
+        }
+        return this.liveRegion;
+    }
+}
+ScreenReaderWeb.errorValueMissing = 'value must be provided.';
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    ScreenReaderWeb: ScreenReaderWeb
+});
+
+exports.ScreenReader = ScreenReader;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst ScreenReader = registerPlugin('ScreenReader', {\n    web: () => import('./web').then(m => new m.ScreenReaderWeb()),\n});\nexport * from './definitions';\nexport { ScreenReader };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class ScreenReaderWeb extends WebPlugin {\n    async announce(options) {\n        if (!options.value) {\n            throw new Error(ScreenReaderWeb.errorValueMissing);\n        }\n        const liveRegion = this.getLiveRegion();\n        // Clear first so that repeating the same message is announced again.\n        liveRegion.textContent = '';\n        window.setTimeout(() => {\n            liveRegion.textContent = options.value;\n        }, 100);\n    }\n    async isEnabled() {\n        throw this.unimplemented('Not implemented on web.');\n    }\n    async addListener() {\n        throw this.unimplemented('Not implemented on web.');\n    }\n    getLiveRegion() {\n        if (!this.liveRegion) {\n            const liveRegion = document.createElement('div');\n            liveRegion.setAttribute('aria-live', 'polite');\n            liveRegion.setAttribute('aria-atomic', 'true');\n            liveRegion.setAttribute('role', 'status');\n            liveRegion.style.position = 'absolute';\n            liveRegion.style.width = '1px';\n            liveRegion.style.height = '1px';\n            liveRegion.style.margin = '-1px';\n            liveRegion.style.padding = '0';\n            liveRegion.style.border = '0';\n            liveRegion.style.overflow = 'hidden';\n            liveRegion.style.clip = 'rect(0, 0, 0, 0)';\n            liveRegion.style.whiteSpace = 'nowrap';\n            document.body.appendChild(liveRegion);\n            this.liveRegion = liveRegion;\n        }\n        return this.liveRegion;\n    }\n}\nScreenReaderWeb.errorValueMissing = 'value must be provided.';\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,YAAY,GAAGA,mBAAc,CAAC,cAAc,EAAE;AACpD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;AACjE,CAAC;;ACFM,MAAM,eAAe,SAASC,cAAS,CAAC;AAC/C,IAAI,MAAM,QAAQ,CAAC,OAAO,EAAE;AAC5B,QAAQ,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;AAC5B,YAAY,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC;AAC9D,QAAQ;AACR,QAAQ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE;AAC/C;AACA,QAAQ,UAAU,CAAC,WAAW,GAAG,EAAE;AACnC,QAAQ,MAAM,CAAC,UAAU,CAAC,MAAM;AAChC,YAAY,UAAU,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK;AAClD,QAAQ,CAAC,EAAE,GAAG,CAAC;AACf,IAAI;AACJ,IAAI,MAAM,SAAS,GAAG;AACtB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC;AAC3D,IAAI;AACJ,IAAI,MAAM,WAAW,GAAG;AACxB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC;AAC3D,IAAI;AACJ,IAAI,aAAa,GAAG;AACpB,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;AAC9B,YAAY,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;AAC5D,YAAY,UAAU,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC;AAC1D,YAAY,UAAU,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC;AAC1D,YAAY,UAAU,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC;AACrD,YAAY,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU;AAClD,YAAY,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK;AAC1C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK;AAC3C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM;AAC5C,YAAY,UAAU,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG;AAC1C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG;AACzC,YAAY,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ;AAChD,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,kBAAkB;AACtD,YAAY,UAAU,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ;AAClD,YAAY,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;AACjD,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU;AACxC,QAAQ;AACR,QAAQ,OAAO,IAAI,CAAC,UAAU;AAC9B,IAAI;AACJ;AACA,eAAe,CAAC,iBAAiB,GAAG,yBAAyB;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,59 @@
+var capacitorScreenReader = (function (exports, core) {
+    'use strict';
+
+    const ScreenReader = core.registerPlugin('ScreenReader', {
+        web: () => Promise.resolve().then(function () { return web; }).then(m => new m.ScreenReaderWeb()),
+    });
+
+    class ScreenReaderWeb extends core.WebPlugin {
+        async announce(options) {
+            if (!options.value) {
+                throw new Error(ScreenReaderWeb.errorValueMissing);
+            }
+            const liveRegion = this.getLiveRegion();
+            // Clear first so that repeating the same message is announced again.
+            liveRegion.textContent = '';
+            window.setTimeout(() => {
+                liveRegion.textContent = options.value;
+            }, 100);
+        }
+        async isEnabled() {
+            throw this.unimplemented('Not implemented on web.');
+        }
+        async addListener() {
+            throw this.unimplemented('Not implemented on web.');
+        }
+        getLiveRegion() {
+            if (!this.liveRegion) {
+                const liveRegion = document.createElement('div');
+                liveRegion.setAttribute('aria-live', 'polite');
+                liveRegion.setAttribute('aria-atomic', 'true');
+                liveRegion.setAttribute('role', 'status');
+                liveRegion.style.position = 'absolute';
+                liveRegion.style.width = '1px';
+                liveRegion.style.height = '1px';
+                liveRegion.style.margin = '-1px';
+                liveRegion.style.padding = '0';
+                liveRegion.style.border = '0';
+                liveRegion.style.overflow = 'hidden';
+                liveRegion.style.clip = 'rect(0, 0, 0, 0)';
+                liveRegion.style.whiteSpace = 'nowrap';
+                document.body.appendChild(liveRegion);
+                this.liveRegion = liveRegion;
+            }
+            return this.liveRegion;
+        }
+    }
+    ScreenReaderWeb.errorValueMissing = 'value must be provided.';
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        ScreenReaderWeb: ScreenReaderWeb
+    });
+
+    exports.ScreenReader = ScreenReader;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst ScreenReader = registerPlugin('ScreenReader', {\n    web: () => import('./web').then(m => new m.ScreenReaderWeb()),\n});\nexport * from './definitions';\nexport { ScreenReader };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class ScreenReaderWeb extends WebPlugin {\n    async announce(options) {\n        if (!options.value) {\n            throw new Error(ScreenReaderWeb.errorValueMissing);\n        }\n        const liveRegion = this.getLiveRegion();\n        // Clear first so that repeating the same message is announced again.\n        liveRegion.textContent = '';\n        window.setTimeout(() => {\n            liveRegion.textContent = options.value;\n        }, 100);\n    }\n    async isEnabled() {\n        throw this.unimplemented('Not implemented on web.');\n    }\n    async addListener() {\n        throw this.unimplemented('Not implemented on web.');\n    }\n    getLiveRegion() {\n        if (!this.liveRegion) {\n            const liveRegion = document.createElement('div');\n            liveRegion.setAttribute('aria-live', 'polite');\n            liveRegion.setAttribute('aria-atomic', 'true');\n            liveRegion.setAttribute('role', 'status');\n            liveRegion.style.position = 'absolute';\n            liveRegion.style.width = '1px';\n            liveRegion.style.height = '1px';\n            liveRegion.style.margin = '-1px';\n            liveRegion.style.padding = '0';\n            liveRegion.style.border = '0';\n            liveRegion.style.overflow = 'hidden';\n            liveRegion.style.clip = 'rect(0, 0, 0, 0)';\n            liveRegion.style.whiteSpace = 'nowrap';\n            document.body.appendChild(liveRegion);\n            this.liveRegion = liveRegion;\n        }\n        return this.liveRegion;\n    }\n}\nScreenReaderWeb.errorValueMissing = 'value must be provided.';\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,YAAY,GAAGA,mBAAc,CAAC,cAAc,EAAE;IACpD,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;IACjE,CAAC;;ICFM,MAAM,eAAe,SAASC,cAAS,CAAC;IAC/C,IAAI,MAAM,QAAQ,CAAC,OAAO,EAAE;IAC5B,QAAQ,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;IAC5B,YAAY,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,iBAAiB,CAAC;IAC9D,QAAQ;IACR,QAAQ,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,EAAE;IAC/C;IACA,QAAQ,UAAU,CAAC,WAAW,GAAG,EAAE;IACnC,QAAQ,MAAM,CAAC,UAAU,CAAC,MAAM;IAChC,YAAY,UAAU,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK;IAClD,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,IAAI;IACJ,IAAI,MAAM,SAAS,GAAG;IACtB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC;IAC3D,IAAI;IACJ,IAAI,MAAM,WAAW,GAAG;IACxB,QAAQ,MAAM,IAAI,CAAC,aAAa,CAAC,yBAAyB,CAAC;IAC3D,IAAI;IACJ,IAAI,aAAa,GAAG;IACpB,QAAQ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;IAC9B,YAAY,MAAM,UAAU,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;IAC5D,YAAY,UAAU,CAAC,YAAY,CAAC,WAAW,EAAE,QAAQ,CAAC;IAC1D,YAAY,UAAU,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC;IAC1D,YAAY,UAAU,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC;IACrD,YAAY,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,UAAU;IAClD,YAAY,UAAU,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK;IAC1C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK;IAC3C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM;IAC5C,YAAY,UAAU,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG;IAC1C,YAAY,UAAU,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG;IACzC,YAAY,UAAU,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ;IAChD,YAAY,UAAU,CAAC,KAAK,CAAC,IAAI,GAAG,kBAAkB;IACtD,YAAY,UAAU,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ;IAClD,YAAY,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC;IACjD,YAAY,IAAI,CAAC,UAAU,GAAG,UAAU;IACxC,QAAQ;IACR,QAAQ,OAAO,IAAI,CAAC,UAAU;IAC9B,IAAI;IACJ;IACA,eAAe,CAAC,iBAAiB,GAAG,yBAAyB;;;;;;;;;;;;;;;"}

package/ios/Plugin/Classes/Events/StateChangeEvent.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class StateChangeEvent: NSObject, Result {
+    let enabled: Bool
+
+    init(enabled: Bool) {
+        self.enabled = enabled
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["enabled"] = enabled
+        return result as AnyObject
+    }
+}

package/ios/Plugin/Classes/Options/AnnounceOptions.swift

@@ -0,0 +1,15 @@
+import Foundation
+import Capacitor
+
+@objc public class AnnounceOptions: NSObject {
+    let value: String
+    let language: String?
+
+    init(_ call: CAPPluginCall) throws {
+        guard let value = call.getString("value") else {
+            throw CustomError.valueMissing
+        }
+        self.value = value
+        self.language = call.getString("language")
+    }
+}

package/ios/Plugin/Classes/Results/IsEnabledResult.swift

@@ -0,0 +1,16 @@
+import Foundation
+import Capacitor
+
+@objc public class IsEnabledResult: NSObject, Result {
+    let enabled: Bool
+
+    init(enabled: Bool) {
+        self.enabled = enabled
+    }
+
+    @objc public func toJSObject() -> AnyObject {
+        var result = JSObject()
+        result["enabled"] = enabled
+        return result as AnyObject
+    }
+}