@tauri-apps/plugin-dialog
Interfaces
ConfirmDialogOptions
Properties
DialogFilter
Extension filters for the file dialog.
Since
2.0.0
Properties
Property | Type | Description |
---|---|---|
extensions | string [] | Extensions to filter, without a Example extensions: [‘svg’, ‘png’] |
name | string | Filter name. |
FileResponse
Properties
Property | Type |
---|---|
base64Data? | string |
duration? | number |
height? | number |
mimeType? | string |
modifiedAt? | number |
name? | string |
path | string |
size | number |
width? | number |
MessageDialogOptions
Since
2.0.0
Properties
OpenDialogOptions
Options for the open dialog.
Since
2.0.0
Properties
Property | Type | Description |
---|---|---|
canCreateDirectories? | boolean | Whether to allow creating directories in the dialog. Enabled by default. macOS Only |
defaultPath? | string | Initial directory or file path. |
directory? | boolean | Whether the dialog is a directory selection or not. |
filters? | DialogFilter [] | The filters of the dialog. |
multiple? | boolean | Whether the dialog allows multiple selection or not. |
recursive? | boolean | If directory is true, indicates that it will be read recursively later. Defines whether subdirectories will be allowed on the scope or not. |
title? | string | The title of the dialog window. |
SaveDialogOptions
Options for the save dialog.
Since
2.0.0
Properties
Property | Type | Description |
---|---|---|
canCreateDirectories? | boolean | Whether to allow creating directories in the dialog. Enabled by default. macOS Only |
defaultPath? | string | 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. |
filters? | DialogFilter [] | The filters of the dialog. |
title? | string | The title of the dialog window. |
Type Aliases
OpenDialogReturn<T>
Type parameters
Type parameter |
---|
T extends OpenDialogOptions |
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L105
Functions
ask()
Shows a question dialog with Yes
and No
buttons.
Parameters
Parameter | Type | Description |
---|---|---|
message | string | The message to show. |
options ? | string | ConfirmDialogOptions | The dialog’s options. If a string, it represents the dialog title. |
Returns
Promise
<boolean
>
A promise resolving to a boolean indicating whether Yes
was clicked or not.
Example
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L253
confirm()
Shows a question dialog with Ok
and Cancel
buttons.
Parameters
Parameter | Type | Description |
---|---|---|
message | string | The message to show. |
options ? | string | ConfirmDialogOptions | The dialog’s options. If a string, it represents the dialog title. |
Returns
Promise
<boolean
>
A promise resolving to a boolean indicating whether Ok
was clicked or not.
Example
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L283
message()
Shows a message dialog with an Ok
button.
Parameters
Parameter | Type | Description |
---|---|---|
message | string | The message to show. |
options ? | string | MessageDialogOptions | The dialog’s options. If a string, it represents the dialog title. |
Returns
Promise
<void
>
A promise indicating the success or failure of the operation.
Example
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L224
open()
Open a file/directory selection dialog.
The selected paths are added to the filesystem and asset protocol scopes. When security is more important than the easy of use of this API, prefer writing a dedicated command instead.
Note that the scope change is not persisted, so the values are cleared when the application is restarted. You can save it to the filesystem using tauri-plugin-persisted-scope.
Type parameters
Type parameter |
---|
T extends OpenDialogOptions |
Parameters
Parameter | Type |
---|---|
options | T |
Returns
A promise resolving to the selected path(s)
Examples
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L165
save()
Open a file/directory save dialog.
The selected path is added to the filesystem and asset protocol scopes. When security is more important than the easy of use of this API, prefer writing a dedicated command instead.
Note that the scope change is not persisted, so the values are cleared when the application is restarted. You can save it to the filesystem using tauri-plugin-persisted-scope.
Parameters
Parameter | Type |
---|---|
options | SaveDialogOptions |
Returns
Promise
<string
| null
>
A promise resolving to the selected path.
Example
Since
2.0.0
Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L199
© 2024 Tauri Contributors. CC-BY / MIT