@tauri-apps/plugin-dialog 2.3.3 → 2.4.1

package/dist-js/index.cjs

@@ -5,6 +5,29 @@ var core = require('@tauri-apps/api/core');
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
+/**
+ * Internal function to convert the buttons to the Rust type.
+ */
+function buttonsToRust(buttons) {
+    if (buttons === undefined) {
+        return undefined;
+    }
+    if (typeof buttons === 'string') {
+        return buttons;
+    }
+    else if ('ok' in buttons && 'cancel' in buttons) {
+        return { OkCancelCustom: [buttons.ok, buttons.cancel] };
+    }
+    else if ('yes' in buttons && 'no' in buttons && 'cancel' in buttons) {
+        return {
+            YesNoCancelCustom: [buttons.yes, buttons.no, buttons.cancel]
+        };
+    }
+    else if ('ok' in buttons) {
+        return { OkCustom: buttons.ok };
+    }
+    return undefined;
+}
 /**
  * Open a file/directory selection dialog.
  *
@@ -112,11 +135,12 @@ async function save(options = {}) {
  */
 async function message(message, options) {
     const opts = typeof options === 'string' ? { title: options } : options;
-    await core.invoke('plugin:dialog|message', {
+    return core.invoke('plugin:dialog|message', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString()
+        okButtonLabel: opts?.okLabel?.toString(),
+        buttons: buttonsToRust(opts?.buttons)
     });
 }
 /**

package/dist-js/index.d.ts

@@ -68,6 +68,61 @@ interface SaveDialogOptions {
     /** Whether to allow creating directories in the dialog. Enabled by default. **macOS Only** */
     canCreateDirectories?: boolean;
 }
+/**
+ * Default buttons for a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogDefaultButtons = 'Ok' | 'OkCancel' | 'YesNo' | 'YesNoCancel';
+/** All possible button keys. */
+type ButtonKey = 'ok' | 'cancel' | 'yes' | 'no';
+/** Ban everything except a set of keys. */
+type BanExcept<Allowed extends ButtonKey> = Partial<Record<Exclude<ButtonKey, Allowed>, never>>;
+/**
+ * The Yes, No and Cancel buttons of a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogButtonsYesNoCancel = {
+    /** The Yes button. */
+    yes: string;
+    /** The No button. */
+    no: string;
+    /** The Cancel button. */
+    cancel: string;
+} & BanExcept<'yes' | 'no' | 'cancel'>;
+/**
+ * The Ok and Cancel buttons of a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogButtonsOkCancel = {
+    /** The Ok button. */
+    ok: string;
+    /** The Cancel button. */
+    cancel: string;
+} & BanExcept<'ok' | 'cancel'>;
+/**
+ * The Ok button of a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogButtonsOk = {
+    /** The Ok button. */
+    ok: string;
+} & BanExcept<'ok'>;
+/**
+ * Custom buttons for a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogCustomButtons = MessageDialogButtonsYesNoCancel | MessageDialogButtonsOkCancel | MessageDialogButtonsOk;
+/**
+ * The buttons of a message dialog.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogButtons = MessageDialogDefaultButtons | MessageDialogCustomButtons;
 /**
  * @since 2.0.0
  */
@@ -76,8 +131,35 @@ interface MessageDialogOptions {
     title?: string;
     /** The kind of the dialog. Defaults to `info`. */
     kind?: 'info' | 'warning' | 'error';
-    /** The label of the confirm button. */
+    /**
+     * The label of the Ok button.
+     *
+     * @deprecated Use {@linkcode MessageDialogOptions.buttons} instead.
+     */
     okLabel?: string;
+    /**
+     * The buttons of the dialog.
+     *
+     * @example
+     *
+     * ```ts
+     * // Use system default buttons texts
+     * await message('Hello World!', { buttons: 'Ok' })
+     * await message('Hello World!', { buttons: 'OkCancel' })
+     *
+     * // Or with custom button texts
+     * await message('Hello World!', { buttons: { ok: 'Yes!' } })
+     * await message('Take on the task?', {
+     *   buttons: { ok: 'Accept', cancel: 'Cancel' }
+     * })
+     * await message('Show the file content?', {
+     *   buttons: { yes: 'Show content', no: 'Show in folder', cancel: 'Cancel' }
+     * })
+     * ```
+     *
+     * @since 2.4.0
+     */
+    buttons?: MessageDialogButtons;
 }
 interface ConfirmDialogOptions {
     /** The title of the dialog. Defaults to the app name. */
@@ -168,6 +250,15 @@ declare function open<T extends OpenDialogOptions>(options?: T): Promise<OpenDia
  * @since 2.0.0
  */
 declare function save(options?: SaveDialogOptions): Promise<string | null>;
+/**
+ * The result of a message dialog.
+ *
+ * The result is a string if the dialog has custom buttons,
+ * otherwise it is one of the default buttons.
+ *
+ * @since 2.4.0
+ */
+export type MessageDialogResult = 'Yes' | 'No' | 'Ok' | 'Cancel' | (string & {});
 /**
  * Shows a message dialog with an `Ok` button.
  * @example
@@ -185,7 +276,7 @@ declare function save(options?: SaveDialogOptions): Promise<string | null>;
  * @since 2.0.0
  *
  */
-declare function message(message: string, options?: string | MessageDialogOptions): Promise<void>;
+declare function message(message: string, options?: string | MessageDialogOptions): Promise<MessageDialogResult>;
 /**
  * Shows a question dialog with `Yes` and `No` buttons.
  * @example

package/dist-js/index.js

@@ -3,6 +3,29 @@ import { invoke } from '@tauri-apps/api/core';
 // Copyright 2019-2023 Tauri Programme within The Commons Conservancy
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-License-Identifier: MIT
+/**
+ * Internal function to convert the buttons to the Rust type.
+ */
+function buttonsToRust(buttons) {
+    if (buttons === undefined) {
+        return undefined;
+    }
+    if (typeof buttons === 'string') {
+        return buttons;
+    }
+    else if ('ok' in buttons && 'cancel' in buttons) {
+        return { OkCancelCustom: [buttons.ok, buttons.cancel] };
+    }
+    else if ('yes' in buttons && 'no' in buttons && 'cancel' in buttons) {
+        return {
+            YesNoCancelCustom: [buttons.yes, buttons.no, buttons.cancel]
+        };
+    }
+    else if ('ok' in buttons) {
+        return { OkCustom: buttons.ok };
+    }
+    return undefined;
+}
 /**
  * Open a file/directory selection dialog.
  *
@@ -110,11 +133,12 @@ async function save(options = {}) {
  */
 async function message(message, options) {
     const opts = typeof options === 'string' ? { title: options } : options;
-    await invoke('plugin:dialog|message', {
+    return invoke('plugin:dialog|message', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString()
+        okButtonLabel: opts?.okLabel?.toString(),
+        buttons: buttonsToRust(opts?.buttons)
     });
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-dialog",
-  "version": "2.3.3",
+  "version": "2.4.1",
   "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"