Skip to main content

dialog

@tauri-apps/api / dialog

Module: dialog

Native system dialogs for opening and saving files.

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

The APIs must be allowlisted on tauri.conf.json:

{
"tauri": {
"allowlist": {
"dialog": {
"all": true, // enable all dialog APIs
"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

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' });

Parameters

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

Defined in

dialog.ts:229


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' });

Parameters

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

Defined in

dialog.ts:259


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' });

Parameters

NameTypeDescription
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.

Defined in

dialog.ts:199


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 Open a selection dialog for image files

import { open } from '@tauri-apps/api/dialog';
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 Open a selection dialog for directories

import { open } from '@tauri-apps/api/dialog';
import { appDir } from '@tauri-apps/api/path';
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
}

Parameters

NameType
optionsOpenDialogOptions

Returns

Promise<null | string | string[]>

A promise resolving to the selected path(s)

Defined in

dialog.ts:132


save

save(options?): Promise<string>

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 Open a save dialog with a defined file extension

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

Parameters

NameType
optionsSaveDialogOptions

Returns

Promise<string>

A promise resolving to the selected path.

Defined in

dialog.ts:171