@capgo/capacitor-pretty-toast 8.1.0

package/dist/docs.json

@@ -0,0 +1,459 @@
+{
+  "api": {
+    "name": "PrettyToastPlugin",
+    "slug": "prettytoastplugin",
+    "docs": "Public toast controller exposed as `toast`.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "show",
+        "signature": "(config: ToastConfig, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show a custom toast and return its id.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "show"
+      },
+      {
+        "name": "success",
+        "signature": "(title: string, config?: ToastConfig | undefined, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "title",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show a success toast.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "success"
+      },
+      {
+        "name": "error",
+        "signature": "(title: string, config?: ToastConfig | undefined, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "title",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show an error toast.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "error"
+      },
+      {
+        "name": "info",
+        "signature": "(title: string, config?: ToastConfig | undefined, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "title",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show an informational toast.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "info"
+      },
+      {
+        "name": "warning",
+        "signature": "(title: string, config?: ToastConfig | undefined, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "title",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show a warning toast.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "warning"
+      },
+      {
+        "name": "loading",
+        "signature": "(title: string, config?: ToastConfig | undefined, options?: ShowOptions | undefined) => string",
+        "parameters": [
+          {
+            "name": "title",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "ToastConfig | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ShowOptions | undefined"
+          }
+        ],
+        "returns": "string",
+        "tags": [],
+        "docs": "Show a loading toast. Loading toasts do not auto-dismiss by default.",
+        "complexTypes": [
+          "ToastConfig",
+          "ShowOptions"
+        ],
+        "slug": "loading"
+      },
+      {
+        "name": "update",
+        "signature": "(id: string, partial: ToastConfig) => void",
+        "parameters": [
+          {
+            "name": "id",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "partial",
+            "docs": "",
+            "type": "ToastConfig"
+          }
+        ],
+        "returns": "void",
+        "tags": [],
+        "docs": "Update an existing toast by id.",
+        "complexTypes": [
+          "ToastConfig"
+        ],
+        "slug": "update"
+      },
+      {
+        "name": "promise",
+        "signature": "<T>(promise: Promise<T>, messages: PromiseMessages<T>) => Promise<T>",
+        "parameters": [
+          {
+            "name": "promise",
+            "docs": "",
+            "type": "Promise<T>"
+          },
+          {
+            "name": "messages",
+            "docs": "",
+            "type": "PromiseMessages<T>"
+          }
+        ],
+        "returns": "Promise<T>",
+        "tags": [],
+        "docs": "Show a loading toast while a promise is pending, then update it for success or error.",
+        "complexTypes": [
+          "T",
+          "PromiseMessages"
+        ],
+        "slug": "promise"
+      },
+      {
+        "name": "dismiss",
+        "signature": "(id?: string | undefined) => void",
+        "parameters": [
+          {
+            "name": "id",
+            "docs": "",
+            "type": "string | undefined"
+          }
+        ],
+        "returns": "void",
+        "tags": [],
+        "docs": "Dismiss one toast by id, or the current toast when no id is provided.",
+        "complexTypes": [],
+        "slug": "dismiss"
+      },
+      {
+        "name": "dismissAll",
+        "signature": "() => void",
+        "parameters": [],
+        "returns": "void",
+        "tags": [],
+        "docs": "Dismiss the current toast and clear the queue.",
+        "complexTypes": [],
+        "slug": "dismissall"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "ToastConfig",
+      "slug": "toastconfig",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [],
+          "docs": "Optional stable toast id. A generated id is returned when omitted.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "icon",
+          "tags": [],
+          "docs": "Accepts either an SF-symbol-like identifier or raw SVG markup.\nSVG mode is enabled only when the string starts with `<svg` after trim.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "iconSource",
+          "tags": [],
+          "docs": "URI-like image source. Supports `https://`, `http://`, `file://`,\nabsolute file paths, `data:` URLs, `blob:` URLs, or `{ uri }`.\n\n`iconSource` always wins over `icon`.",
+          "complexTypes": [
+            "IconSource"
+          ],
+          "type": "IconSource"
+        },
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Main toast title.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "Secondary toast message.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Auto-dismiss delay in milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "autoDismiss",
+          "tags": [],
+          "docs": "Whether the toast dismisses itself after `duration`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "enableSwipeDismiss",
+          "tags": [],
+          "docs": "Whether swipe-to-dismiss is enabled on native overlays.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "accentColor",
+          "tags": [],
+          "docs": "CSS-style accent color used by native/web renderers.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "strokeColor",
+          "tags": [],
+          "docs": "CSS-style border/stroke color.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "disableBackdropSampling",
+          "tags": [],
+          "docs": "Disable Android/iOS backdrop sampling behind the toast.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "action",
+          "tags": [],
+          "docs": "Optional action button configuration.",
+          "complexTypes": [
+            "ToastAction"
+          ],
+          "type": "ToastAction"
+        },
+        {
+          "name": "accessibilityAnnouncement",
+          "tags": [],
+          "docs": "Text announced to assistive technologies when the toast is shown.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "onPress",
+          "tags": [],
+          "docs": "Called when the toast body is pressed.",
+          "complexTypes": [],
+          "type": "(() => void) | undefined"
+        },
+        {
+          "name": "onShow",
+          "tags": [],
+          "docs": "Called when the toast becomes visible.",
+          "complexTypes": [],
+          "type": "(() => void) | undefined"
+        },
+        {
+          "name": "onHide",
+          "tags": [],
+          "docs": "Called when the toast is dismissed.",
+          "complexTypes": [],
+          "type": "(() => void) | undefined"
+        },
+        {
+          "name": "onAutoDismiss",
+          "tags": [],
+          "docs": "Called when the toast is dismissed by its timer.",
+          "complexTypes": [],
+          "type": "(() => void) | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ToastAction",
+      "slug": "toastaction",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "label",
+          "tags": [],
+          "docs": "Text shown for the native/web action button.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "onPress",
+          "tags": [],
+          "docs": "Called when the action button is pressed.",
+          "complexTypes": [],
+          "type": "() => void"
+        }
+      ]
+    },
+    {
+      "name": "ShowOptions",
+      "slug": "showoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "force",
+          "tags": [],
+          "docs": "Dismiss the current toast and show this one immediately.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "IconSource",
+      "slug": "iconsource",
+      "docs": "",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        },
+        {
+          "text": "{ uri: string }",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PromiseMessages",
+      "slug": "promisemessages",
+      "docs": "",
+      "types": [
+        {
+          "text": "{\n  loading: string | ToastConfig;\n  success: string | ((value: T) => string | ToastConfig);\n  error: string | ((error: unknown) => string | ToastConfig);\n}",
+          "complexTypes": [
+            "ToastConfig",
+            "T"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/controller.d.ts

@@ -0,0 +1,30 @@
+import type { PromiseMessages, ShowOptions, ToastConfig, ToastRef } from './definitions';
+import type { ToastDriver } from './driver';
+export declare class ToastController {
+    private readonly driver;
+    private queue;
+    private current;
+    private isShowing;
+    private idCounter;
+    private autoDismissTimer;
+    private autoDismissed;
+    readonly ref: ToastRef;
+    constructor(driver: ToastDriver);
+    show(config: ToastConfig, options?: ShowOptions): string;
+    update(id: string, partial: Partial<Omit<ToastConfig, 'id'>>): void;
+    dismiss(id?: string): void;
+    dismissAll(): void;
+    promise<T>(promise: Promise<T>, messages: PromiseMessages<T>): Promise<T>;
+    private showVariant;
+    private presentToast;
+    private showNext;
+    private handleDismiss;
+    private handlePress;
+    private handleActionPress;
+    private armAutoDismissTimer;
+    private clearAutoDismissTimer;
+    private hydrateEntry;
+    private buildPayload;
+    private prepareSvgIcon;
+    private generateId;
+}