@wailsio/runtime 3.0.0-alpha.64 → 3.0.0-alpha.66

package/types/dialogs.d.ts

@@ -1,184 +1,140 @@
-export function Info(options: MessageDialogOptions): Promise<string>;
-export function Warning(options: MessageDialogOptions): Promise<string>;
-export function Error(options: MessageDialogOptions): Promise<string>;
-export function Question(options: MessageDialogOptions): Promise<string>;
-export function OpenFile(options: OpenFileDialogOptions): Promise<string[] | string>;
-export function SaveFile(options: SaveFileDialogOptions): Promise<string>;
-export type OpenFileDialogOptions = {
-    /**
-     * - Indicates if directories can be chosen.
-     */
+export interface OpenFileDialogOptions {
+    /** Indicates if directories can be chosen. */
     CanChooseDirectories?: boolean;
-    /**
-     * - Indicates if files can be chosen.
-     */
+    /** Indicates if files can be chosen. */
     CanChooseFiles?: boolean;
-    /**
-     * - Indicates if directories can be created.
-     */
+    /** Indicates if directories can be created. */
     CanCreateDirectories?: boolean;
-    /**
-     * - Indicates if hidden files should be shown.
-     */
+    /** Indicates if hidden files should be shown. */
     ShowHiddenFiles?: boolean;
-    /**
-     * - Indicates if aliases should be resolved.
-     */
+    /** Indicates if aliases should be resolved. */
     ResolvesAliases?: boolean;
-    /**
-     * - Indicates if multiple selection is allowed.
-     */
+    /** Indicates if multiple selection is allowed. */
     AllowsMultipleSelection?: boolean;
-    /**
-     * - Indicates if the extension should be hidden.
-     */
+    /** Indicates if the extension should be hidden. */
     HideExtension?: boolean;
-    /**
-     * - Indicates if hidden extensions can be selected.
-     */
+    /** Indicates if hidden extensions can be selected. */
     CanSelectHiddenExtension?: boolean;
-    /**
-     * - Indicates if file packages should be treated as directories.
-     */
+    /** Indicates if file packages should be treated as directories. */
     TreatsFilePackagesAsDirectories?: boolean;
-    /**
-     * - Indicates if other file types are allowed.
-     */
+    /** Indicates if other file types are allowed. */
     AllowsOtherFiletypes?: boolean;
-    /**
-     * - Array of file filters.
-     */
+    /** Array of file filters. */
     Filters?: FileFilter[];
-    /**
-     * - Title of the dialog.
-     */
+    /** Title of the dialog. */
     Title?: string;
-    /**
-     * - Message to show in the dialog.
-     */
+    /** Message to show in the dialog. */
     Message?: string;
-    /**
-     * - Text to display on the button.
-     */
+    /** Text to display on the button. */
     ButtonText?: string;
-    /**
-     * - Directory to open in the dialog.
-     */
+    /** Directory to open in the dialog. */
     Directory?: string;
-    /**
-     * - Indicates if the dialog should appear detached from the main window.
-     */
+    /** Indicates if the dialog should appear detached from the main window. */
     Detached?: boolean;
-};
-export type SaveFileDialogOptions = {
-    /**
-     * - Default filename to use in the dialog.
-     */
+}
+export interface SaveFileDialogOptions {
+    /** Default filename to use in the dialog. */
     Filename?: string;
-    /**
-     * - Indicates if directories can be chosen.
-     */
+    /** Indicates if directories can be chosen. */
     CanChooseDirectories?: boolean;
-    /**
-     * - Indicates if files can be chosen.
-     */
+    /** Indicates if files can be chosen. */
     CanChooseFiles?: boolean;
-    /**
-     * - Indicates if directories can be created.
-     */
+    /** Indicates if directories can be created. */
     CanCreateDirectories?: boolean;
-    /**
-     * - Indicates if hidden files should be shown.
-     */
+    /** Indicates if hidden files should be shown. */
     ShowHiddenFiles?: boolean;
-    /**
-     * - Indicates if aliases should be resolved.
-     */
+    /** Indicates if aliases should be resolved. */
     ResolvesAliases?: boolean;
-    /**
-     * - Indicates if multiple selection is allowed.
-     */
-    AllowsMultipleSelection?: boolean;
-    /**
-     * - Indicates if the extension should be hidden.
-     */
+    /** Indicates if the extension should be hidden. */
     HideExtension?: boolean;
-    /**
-     * - Indicates if hidden extensions can be selected.
-     */
+    /** Indicates if hidden extensions can be selected. */
     CanSelectHiddenExtension?: boolean;
-    /**
-     * - Indicates if file packages should be treated as directories.
-     */
+    /** Indicates if file packages should be treated as directories. */
     TreatsFilePackagesAsDirectories?: boolean;
-    /**
-     * - Indicates if other file types are allowed.
-     */
+    /** Indicates if other file types are allowed. */
     AllowsOtherFiletypes?: boolean;
-    /**
-     * - Array of file filters.
-     */
+    /** Array of file filters. */
     Filters?: FileFilter[];
-    /**
-     * - Title of the dialog.
-     */
+    /** Title of the dialog. */
     Title?: string;
-    /**
-     * - Message to show in the dialog.
-     */
+    /** Message to show in the dialog. */
     Message?: string;
-    /**
-     * - Text to display on the button.
-     */
+    /** Text to display on the button. */
     ButtonText?: string;
-    /**
-     * - Directory to open in the dialog.
-     */
+    /** Directory to open in the dialog. */
     Directory?: string;
-    /**
-     * - Indicates if the dialog should appear detached from the main window.
-     */
+    /** Indicates if the dialog should appear detached from the main window. */
     Detached?: boolean;
-};
-export type MessageDialogOptions = {
-    /**
-     * - The title of the dialog window.
-     */
+}
+export interface MessageDialogOptions {
+    /** The title of the dialog window. */
     Title?: string;
-    /**
-     * - The main message to show in the dialog.
-     */
+    /** The main message to show in the dialog. */
     Message?: string;
-    /**
-     * - Array of button options to show in the dialog.
-     */
+    /** Array of button options to show in the dialog. */
     Buttons?: Button[];
-    /**
-     * - True if the dialog should appear detached from the main window (if applicable).
-     */
+    /** True if the dialog should appear detached from the main window (if applicable). */
     Detached?: boolean;
-};
-export type Button = {
-    /**
-     * - Text that appears within the button.
-     */
+}
+export interface Button {
+    /** Text that appears within the button. */
     Label?: string;
-    /**
-     * - True if the button should cancel an operation when clicked.
-     */
+    /** True if the button should cancel an operation when clicked. */
     IsCancel?: boolean;
-    /**
-     * - True if the button should be the default action when the user presses enter.
-     */
+    /** True if the button should be the default action when the user presses enter. */
     IsDefault?: boolean;
-};
-export type FileFilter = {
-    /**
-     * - Display name for the filter, it could be "Text Files", "Images" etc.
-     */
+}
+export interface FileFilter {
+    /** Display name for the filter, it could be "Text Files", "Images" etc. */
     DisplayName?: string;
-    /**
-     * - Pattern to match for the filter, e.g. "*.txt;*.md" for text markdown files.
-     */
+    /** Pattern to match for the filter, e.g. "*.txt;*.md" for text markdown files. */
     Pattern?: string;
-};
+}
+/**
+ * Presents an info dialog.
+ *
+ * @param options - Dialog options
+ * @returns A promise that resolves with the label of the chosen button.
+ */
+export declare function Info(options: MessageDialogOptions): Promise<string>;
+/**
+ * Presents a warning dialog.
+ *
+ * @param options - Dialog options.
+ * @returns A promise that resolves with the label of the chosen button.
+ */
+export declare function Warning(options: MessageDialogOptions): Promise<string>;
+/**
+ * Presents an error dialog.
+ *
+ * @param options - Dialog options.
+ * @returns A promise that resolves with the label of the chosen button.
+ */
+export declare function Error(options: MessageDialogOptions): Promise<string>;
+/**
+ * Presents a question dialog.
+ *
+ * @param options - Dialog options.
+ * @returns A promise that resolves with the label of the chosen button.
+ */
+export declare function Question(options: MessageDialogOptions): Promise<string>;
+/**
+ * Presents a file selection dialog to pick one or more files to open.
+ *
+ * @param options - Dialog options.
+ * @returns Selected file or list of files, or a blank string/empty list if no file has been selected.
+ */
+export declare function OpenFile(options: OpenFileDialogOptions & {
+    AllowsMultipleSelection: true;
+}): Promise<string[]>;
+export declare function OpenFile(options: OpenFileDialogOptions & {
+    AllowsMultipleSelection?: false | undefined;
+}): Promise<string>;
+export declare function OpenFile(options: OpenFileDialogOptions): Promise<string | string[]>;
+/**
+ * Presents a file selection dialog to pick a file to save.
+ *
+ * @param options - Dialog options.
+ * @returns Selected file, or a blank string if no file has been selected.
+ */
+export declare function SaveFile(options: SaveFileDialogOptions): Promise<string>;

package/types/drag.d.ts

@@ -0,0 +1 @@
+export {};