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

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** */
@@ -90,7 +89,7 @@ interface ConfirmDialogOptions {
     /** 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-dialog",
-  "version": "2.0.0-rc.0",
+  "version": "2.0.0-rc.1",
   "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-rc.4"
   }
 }