Skip to content
Tauri
Releases

dialog

Native system dialogs for opening and saving files.

This package is also accessible with window.__TAURI__.dialog when build.withGlobalTauri in tauri.conf.json is set to true.

The APIs must be added to tauri.allowlist.dialog in tauri.conf.json:

{
"tauri": {
"allowlist": {
"dialog": {
"all": true, // enable all dialog APIs
"ask": true, // enable dialog ask API
"confirm": true, // enable dialog confirm API
"message": true, // enable dialog message API
"open": true, // enable file open API
"save": true // enable file save API
}
}
}
}

It is recommended to allowlist only the APIs you use for optimal bundle size and security.

Interfaces

ConfirmDialogOptions

Properties

PropertyTypeDescription
cancelLabel?stringThe label of the cancel button.
okLabel?stringThe label of the confirm button.
title?stringThe title of the dialog. Defaults to the app name.
type?"info" | "warning" | "error"The type of the dialog. Defaults to info.

DialogFilter

Extension filters for the file dialog.

Since

1.0.0

Properties

PropertyTypeDescription
extensionsstring[]Extensions to filter, without a . prefix.

Example

typescript extensions: ['svg', 'png']
namestringFilter name.

MessageDialogOptions

Since

1.0.0

Properties

PropertyTypeDescription
okLabel?stringThe label of the confirm button.
title?stringThe title of the dialog. Defaults to the app name.
type?"info" | "warning" | "error"The type of the dialog. Defaults to info.

OpenDialogOptions

Options for the open dialog.

Since

1.0.0

Properties

PropertyTypeDescription
defaultPath?stringInitial directory or file path.
directory?booleanWhether the dialog is a directory selection or not.
filters?DialogFilter[]The filters of the dialog.
multiple?booleanWhether the dialog allows multiple selection or not.
recursive?booleanIf directory is true, indicates that it will be read recursively later.
Defines whether subdirectories will be allowed on the scope or not.
title?stringThe title of the dialog window.

SaveDialogOptions

Options for the save dialog.

Since

1.0.0

Properties

PropertyTypeDescription
defaultPath?stringInitial 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?stringThe title of the dialog window.

Functions

ask()

ask(message, options?): Promise< boolean >

Shows a question dialog with Yes and No buttons.

Example

import { ask } from '@tauri-apps/api/dialog';
const yes = await ask('Are you sure?', 'Tauri');
const yes2 = await ask('This action cannot be reverted. Are you sure?', {
title: 'Tauri',
type: 'warning',
});

Since

1.0.0

Parameters

ParameterTypeDescription
messagestringThe message to show.
options?string | ConfirmDialogOptionsThe 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.

Source: dialog.ts:271


confirm()

confirm(message, options?): Promise< boolean >

Shows a question dialog with Ok and Cancel buttons.

Example

import { confirm } from '@tauri-apps/api/dialog';
const confirmed = await confirm('Are you sure?', 'Tauri');
const confirmed2 = await confirm('This action cannot be reverted. Are you sure?', {
title: 'Tauri',
type: 'warning',
});

Since

1.0.0

Parameters

ParameterTypeDescription
messagestringThe message to show.
options?string | ConfirmDialogOptionsThe 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.

Source: dialog.ts:307


message()

message(message, options?): Promise< void >

Shows a message dialog with an Ok button.

Example

import { message } from '@tauri-apps/api/dialog';
await message('Tauri is awesome', 'Tauri');
await message('File not found', { title: 'Tauri', type: 'error' });

Since

1.0.0

Parameters

ParameterTypeDescription
messagestringThe message to show.
options?string | MessageDialogOptionsThe dialog’s options. If a string, it represents the dialog title.

Returns

Promise< void >

A promise indicating the success or failure of the operation.

Source: dialog.ts:238


open()

open(options = {}): Promise< null | string | string[] >

Open a file/directory selection dialog.

The selected paths are added to the filesystem and asset protocol allowlist scopes. When security is more important than the easy of use of this API, prefer writing a dedicated command instead.

Note that the allowlist 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.

Example

import { open } from '@tauri-apps/api/dialog';
// Open a selection dialog for image files
const selected = await open({
multiple: true,
filters: [
{
name: 'Image',
extensions: ['png', 'jpeg'],
},
],
});
if (Array.isArray(selected)) {
// user selected multiple files
} else if (selected === null) {
// user cancelled the selection
} else {
// user selected a single file
}

Example

import { open } from '@tauri-apps/api/dialog';
import { appDir } from '@tauri-apps/api/path';
// Open a selection dialog for directories
const selected = await open({
directory: true,
multiple: true,
defaultPath: await appDir(),
});
if (Array.isArray(selected)) {
// user selected multiple directories
} else if (selected === null) {
// user cancelled the selection
} else {
// user selected a single directory
}

Since

1.0.0

Parameters

ParameterType
optionsOpenDialogOptions

Returns

Promise< null | string | string[] >

A promise resolving to the selected path(s)

Source: dialog.ts:167


save()

save(options = {}): Promise< string | null >

Open a file/directory save dialog.

The selected path is added to the filesystem and asset protocol allowlist scopes. When security is more important than the easy of use of this API, prefer writing a dedicated command instead.

Note that the allowlist 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.

Example

import { save } from '@tauri-apps/api/dialog';
const filePath = await save({
filters: [
{
name: 'Image',
extensions: ['png', 'jpeg'],
},
],
});

Since

1.0.0

Parameters

ParameterType
optionsSaveDialogOptions

Returns

Promise< string | null >

A promise resolving to the selected path.

Source: dialog.ts:207


© 2024 Tauri Contributors. CC-BY / MIT