@capawesome/capacitor-dialog 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/dialog/classes/options/ConfirmOptions.java

@@ -0,0 +1,52 @@
+package io.capawesome.capacitorjs.plugins.dialog.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.dialog.classes.CustomExceptions;
+
+public class ConfirmOptions {
+
+    @NonNull
+    private final String cancelButtonTitle;
+
+    @NonNull
+    private final String message;
+
+    @NonNull
+    private final String okButtonTitle;
+
+    @Nullable
+    private final String title;
+
+    public ConfirmOptions(@NonNull PluginCall call) throws Exception {
+        String message = call.getString("message");
+        if (message == null) {
+            throw CustomExceptions.MESSAGE_MISSING;
+        }
+        this.message = message;
+        this.cancelButtonTitle = call.getString("cancelButtonTitle", "Cancel");
+        this.okButtonTitle = call.getString("okButtonTitle", "OK");
+        this.title = call.getString("title");
+    }
+
+    @NonNull
+    public String getCancelButtonTitle() {
+        return cancelButtonTitle;
+    }
+
+    @NonNull
+    public String getMessage() {
+        return message;
+    }
+
+    @NonNull
+    public String getOkButtonTitle() {
+        return okButtonTitle;
+    }
+
+    @Nullable
+    public String getTitle() {
+        return title;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/dialog/classes/options/PromptOptions.java

@@ -0,0 +1,70 @@
+package io.capawesome.capacitorjs.plugins.dialog.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.dialog.classes.CustomExceptions;
+
+public class PromptOptions {
+
+    @NonNull
+    private final String cancelButtonTitle;
+
+    @Nullable
+    private final String inputPlaceholder;
+
+    @Nullable
+    private final String inputText;
+
+    @NonNull
+    private final String message;
+
+    @NonNull
+    private final String okButtonTitle;
+
+    @Nullable
+    private final String title;
+
+    public PromptOptions(@NonNull PluginCall call) throws Exception {
+        String message = call.getString("message");
+        if (message == null) {
+            throw CustomExceptions.MESSAGE_MISSING;
+        }
+        this.message = message;
+        this.cancelButtonTitle = call.getString("cancelButtonTitle", "Cancel");
+        this.inputPlaceholder = call.getString("inputPlaceholder");
+        this.inputText = call.getString("inputText");
+        this.okButtonTitle = call.getString("okButtonTitle", "OK");
+        this.title = call.getString("title");
+    }
+
+    @NonNull
+    public String getCancelButtonTitle() {
+        return cancelButtonTitle;
+    }
+
+    @Nullable
+    public String getInputPlaceholder() {
+        return inputPlaceholder;
+    }
+
+    @Nullable
+    public String getInputText() {
+        return inputText;
+    }
+
+    @NonNull
+    public String getMessage() {
+        return message;
+    }
+
+    @NonNull
+    public String getOkButtonTitle() {
+        return okButtonTitle;
+    }
+
+    @Nullable
+    public String getTitle() {
+        return title;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/dialog/classes/results/ConfirmResult.java

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

package/android/src/main/java/io/capawesome/capacitorjs/plugins/dialog/classes/results/PromptResult.java

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.dialog.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/dialog/interfaces/Result.java

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

package/dist/docs.json

@@ -0,0 +1,433 @@
+{
+  "api": {
+    "name": "DialogPlugin",
+    "slug": "dialogplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "alert",
+        "signature": "(options: AlertOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "AlertOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Display an alert dialog with a single button.",
+        "complexTypes": [
+          "AlertOptions"
+        ],
+        "slug": "alert"
+      },
+      {
+        "name": "confirm",
+        "signature": "(options: ConfirmOptions) => Promise<ConfirmResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ConfirmOptions"
+          }
+        ],
+        "returns": "Promise<ConfirmResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Display a confirmation dialog with two buttons.",
+        "complexTypes": [
+          "ConfirmResult",
+          "ConfirmOptions"
+        ],
+        "slug": "confirm"
+      },
+      {
+        "name": "prompt",
+        "signature": "(options: PromptOptions) => Promise<PromptResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PromptOptions"
+          }
+        ],
+        "returns": "Promise<PromptResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Display a prompt dialog with a text input, a confirm and a cancel button.",
+        "complexTypes": [
+          "PromptResult",
+          "PromptOptions"
+        ],
+        "slug": "prompt"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "AlertOptions",
+      "slug": "alertoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "buttonTitle",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'OK'",
+              "name": "default"
+            },
+            {
+              "text": "'Got it'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the button that confirms the dialog.\n\nOn the web, the button title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Your changes have been saved.'",
+              "name": "example"
+            }
+          ],
+          "docs": "The message to display in the dialog.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "title",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Success'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the dialog.\n\nOn the web, the title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ConfirmResult",
+      "slug": "confirmresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether the user confirmed the dialog.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ConfirmOptions",
+      "slug": "confirmoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cancelButtonTitle",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Cancel'",
+              "name": "default"
+            },
+            {
+              "text": "'No'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the button that cancels the dialog.\n\nOn the web, the button title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Do you want to delete this item?'",
+              "name": "example"
+            }
+          ],
+          "docs": "The message to display in the dialog.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "okButtonTitle",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'OK'",
+              "name": "default"
+            },
+            {
+              "text": "'Yes'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the button that confirms the dialog.\n\nOn the web, the button title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "title",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Confirm'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the dialog.\n\nOn the web, the title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PromptResult",
+      "slug": "promptresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "canceled",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether the user canceled the dialog.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'John Doe'",
+              "name": "example"
+            }
+          ],
+          "docs": "The value of the text input.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "PromptOptions",
+      "slug": "promptoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cancelButtonTitle",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Cancel'",
+              "name": "default"
+            },
+            {
+              "text": "'No'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the button that cancels the dialog.\n\nOn the web, the button title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "inputPlaceholder",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Enter your name'",
+              "name": "example"
+            }
+          ],
+          "docs": "The placeholder of the text input.\n\nOn the web, the placeholder cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "inputText",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'John Doe'",
+              "name": "example"
+            }
+          ],
+          "docs": "The initial value of the text input.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'What is your name?'",
+              "name": "example"
+            }
+          ],
+          "docs": "The message to display in the dialog.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "okButtonTitle",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'OK'",
+              "name": "default"
+            },
+            {
+              "text": "'Submit'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the button that confirms the dialog.\n\nOn the web, the button title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "title",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'Name'",
+              "name": "example"
+            }
+          ],
+          "docs": "The title of the dialog.\n\nOn the web, the title cannot be customized and is ignored.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [],
+  "pluginConfigs": []
+}