@tauri-apps/plugin-dialog 2.0.0-rc.0 → 2.0.0

package/README.md

@@ -2,9 +2,17 @@
 
 Native system dialogs for opening and saving files along with message dialogs.
 
+| Platform | Supported |
+| -------- | --------- |
+| Linux    | ✓         |
+| Windows  | ✓         |
+| macOS    | ✓         |
+| Android  | ✓         |
+| iOS      | ✓         |
+
 ## Install
 
-_This plugin requires a Rust version of at least **1.75**_
+_This plugin requires a Rust version of at least **1.78**_
 
 There are three general methods of installation that we can recommend.
 
@@ -18,7 +26,7 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
 
 ```toml
 [dependencies]
-tauri-plugin-dialog = "2.0.0-rc"
+tauri-plugin-dialog = "2.0.0"
 # alternatively with Git:
 tauri-plugin-dialog = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
 ```

package/dist-js/index.cjs

@@ -58,10 +58,10 @@ var core = require('@tauri-apps/api/core');
  * @since 2.0.0
  */
 async function open(options = {}) {
-    if (typeof options === "object") {
+    if (typeof options === 'object') {
         Object.freeze(options);
     }
-    return await core.invoke("plugin:dialog|open", { options });
+    return await core.invoke('plugin:dialog|open', { options });
 }
 /**
  * Open a file/directory save dialog.
@@ -88,10 +88,10 @@ async function open(options = {}) {
  * @since 2.0.0
  */
 async function save(options = {}) {
-    if (typeof options === "object") {
+    if (typeof options === 'object') {
         Object.freeze(options);
     }
-    return await core.invoke("plugin:dialog|save", { options });
+    return await core.invoke('plugin:dialog|save', { options });
 }
 /**
  * Shows a message dialog with an `Ok` button.
@@ -111,12 +111,12 @@ async function save(options = {}) {
  *
  */
 async function message(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    await core.invoke("plugin:dialog|message", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    await core.invoke('plugin:dialog|message', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString(),
+        okButtonLabel: opts?.okLabel?.toString()
     });
 }
 /**
@@ -136,13 +136,13 @@ async function message(message, options) {
  * @since 2.0.0
  */
 async function ask(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    return await core.invoke("plugin:dialog|ask", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    return await core.invoke('plugin:dialog|ask', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString() ?? "Yes",
-        cancelButtonLabel: opts?.cancelLabel?.toString() ?? "No",
+        okButtonLabel: opts?.okLabel?.toString() ?? 'Yes',
+        cancelButtonLabel: opts?.cancelLabel?.toString() ?? 'No'
     });
 }
 /**
@@ -162,13 +162,13 @@ async function ask(message, options) {
  * @since 2.0.0
  */
 async function confirm(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    return await core.invoke("plugin:dialog|confirm", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    return await core.invoke('plugin:dialog|confirm', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString() ?? "Ok",
-        cancelButtonLabel: opts?.cancelLabel?.toString() ?? "Cancel",
+        okButtonLabel: opts?.okLabel?.toString() ?? 'Ok',
+        cancelButtonLabel: opts?.cancelLabel?.toString() ?? 'Cancel'
     });
 }
 

package/dist-js/index.d.ts

@@ -1,14 +1,3 @@
-interface FileResponse {
-    base64Data?: string;
-    duration?: number;
-    height?: number;
-    width?: number;
-    mimeType?: string;
-    modifiedAt?: number;
-    name?: string;
-    path: string;
-    size: number;
-}
 /**
  * Extension filters for the file dialog.
  *
@@ -32,11 +21,18 @@ interface DialogFilter {
  * @since 2.0.0
  */
 interface OpenDialogOptions {
-    /** The title of the dialog window. */
+    /** The title of the dialog window (desktop only). */
     title?: string;
     /** The filters of the dialog. */
     filters?: DialogFilter[];
-    /** Initial directory or file path. */
+    /**
+     * Initial directory or file path.
+     * If it's a directory path, the dialog interface will change to that folder.
+     * If it's not an existing directory, the file name will be set to the dialog's file name input and the dialog will be set to the parent folder.
+     *
+     * On mobile the file name is always used on the dialog's file name input.
+     * If not provided, Android uses `(invalid).txt` as default file name.
+     */
     defaultPath?: string;
     /** Whether the dialog allows multiple selection or not. */
     multiple?: boolean;
@@ -56,7 +52,7 @@ interface OpenDialogOptions {
  * @since 2.0.0
  */
 interface SaveDialogOptions {
-    /** The title of the dialog window. */
+    /** The title of the dialog window (desktop only). */
     title?: string;
     /** The filters of the dialog. */
     filters?: DialogFilter[];
@@ -64,6 +60,9 @@ interface SaveDialogOptions {
      * Initial directory or file path.
      * If it's a directory path, the dialog interface will change to that folder.
      * If it's not an existing directory, the file name will be set to the dialog's file name input and the dialog will be set to the parent folder.
+     *
+     * On mobile the file name is always used on the dialog's file name input.
+     * If not provided, Android uses `(invalid).txt` as default file name.
      */
     defaultPath?: string;
     /** Whether to allow creating directories in the dialog. Enabled by default. **macOS Only** */
@@ -76,7 +75,7 @@ interface MessageDialogOptions {
     /** The title of the dialog. Defaults to the app name. */
     title?: string;
     /** The kind of the dialog. Defaults to `info`. */
-    kind?: "info" | "warning" | "error";
+    kind?: 'info' | 'warning' | 'error';
     /** The label of the confirm button. */
     okLabel?: string;
 }
@@ -84,13 +83,13 @@ interface ConfirmDialogOptions {
     /** The title of the dialog. Defaults to the app name. */
     title?: string;
     /** The kind of the dialog. Defaults to `info`. */
-    kind?: "info" | "warning" | "error";
+    kind?: 'info' | 'warning' | 'error';
     /** The label of the confirm button. */
     okLabel?: string;
     /** The label of the cancel button. */
     cancelLabel?: string;
 }
-type OpenDialogReturn<T extends OpenDialogOptions> = T["directory"] extends true ? T["multiple"] extends true ? string[] | null : string | null : T["multiple"] extends true ? FileResponse[] | null : FileResponse | null;
+type OpenDialogReturn<T extends OpenDialogOptions> = T['directory'] extends true ? T['multiple'] extends true ? string[] | null : string | null : T['multiple'] extends true ? string[] | null : string | null;
 /**
  * Open a file/directory selection dialog.
  *
@@ -221,5 +220,5 @@ declare function ask(message: string, options?: string | ConfirmDialogOptions):
  * @since 2.0.0
  */
 declare function confirm(message: string, options?: string | ConfirmDialogOptions): Promise<boolean>;
-export type { DialogFilter, FileResponse, OpenDialogOptions, OpenDialogReturn, SaveDialogOptions, MessageDialogOptions, ConfirmDialogOptions, };
+export type { DialogFilter, OpenDialogOptions, OpenDialogReturn, SaveDialogOptions, MessageDialogOptions, ConfirmDialogOptions };
 export { open, save, message, ask, confirm };

package/dist-js/index.js

@@ -56,10 +56,10 @@ import { invoke } from '@tauri-apps/api/core';
  * @since 2.0.0
  */
 async function open(options = {}) {
-    if (typeof options === "object") {
+    if (typeof options === 'object') {
         Object.freeze(options);
     }
-    return await invoke("plugin:dialog|open", { options });
+    return await invoke('plugin:dialog|open', { options });
 }
 /**
  * Open a file/directory save dialog.
@@ -86,10 +86,10 @@ async function open(options = {}) {
  * @since 2.0.0
  */
 async function save(options = {}) {
-    if (typeof options === "object") {
+    if (typeof options === 'object') {
         Object.freeze(options);
     }
-    return await invoke("plugin:dialog|save", { options });
+    return await invoke('plugin:dialog|save', { options });
 }
 /**
  * Shows a message dialog with an `Ok` button.
@@ -109,12 +109,12 @@ async function save(options = {}) {
  *
  */
 async function message(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    await invoke("plugin:dialog|message", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    await invoke('plugin:dialog|message', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString(),
+        okButtonLabel: opts?.okLabel?.toString()
     });
 }
 /**
@@ -134,13 +134,13 @@ async function message(message, options) {
  * @since 2.0.0
  */
 async function ask(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    return await invoke("plugin:dialog|ask", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    return await invoke('plugin:dialog|ask', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString() ?? "Yes",
-        cancelButtonLabel: opts?.cancelLabel?.toString() ?? "No",
+        okButtonLabel: opts?.okLabel?.toString() ?? 'Yes',
+        cancelButtonLabel: opts?.cancelLabel?.toString() ?? 'No'
     });
 }
 /**
@@ -160,13 +160,13 @@ async function ask(message, options) {
  * @since 2.0.0
  */
 async function confirm(message, options) {
-    const opts = typeof options === "string" ? { title: options } : options;
-    return await invoke("plugin:dialog|confirm", {
+    const opts = typeof options === 'string' ? { title: options } : options;
+    return await invoke('plugin:dialog|confirm', {
         message: message.toString(),
         title: opts?.title?.toString(),
         kind: opts?.kind,
-        okButtonLabel: opts?.okLabel?.toString() ?? "Ok",
-        cancelButtonLabel: opts?.cancelLabel?.toString() ?? "Cancel",
+        okButtonLabel: opts?.okLabel?.toString() ?? 'Ok',
+        cancelButtonLabel: opts?.cancelLabel?.toString() ?? 'Cancel'
     });
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tauri-apps/plugin-dialog",
-  "version": "2.0.0-rc.0",
-  "license": "MIT or APACHE-2.0",
+  "version": "2.0.0",
+  "license": "MIT OR Apache-2.0",
   "authors": [
     "Tauri Programme within The Commons Conservancy"
   ],
@@ -24,6 +24,6 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@tauri-apps/api": "^2.0.0-rc.0"
+    "@tauri-apps/api": "^2.0.0"
   }
 }