跳至內容
Tauri
指南 參考 部落格 發行版本

@tauri-apps/plugin-dialog

介面

ConfirmDialogOptions

屬性

屬性類型描述定義於
cancelLabel?string取消按鈕的標籤。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L100
kind?"info" | "warning" | "error"對話方塊的種類。預設為 info。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L96
okLabel?string確認按鈕的標籤。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L98
title?string對話方塊的標題。預設為應用程式名稱。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L94

DialogFilter

檔案對話方塊的副檔名篩選器。

自

2.0.0

屬性

屬性類型描述定義於
extensionsstring[]要篩選的副檔名，不含 . 前綴。範例 extensions: ['svg', 'png']來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L22
namestring篩選器名稱。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L14

MessageDialogOptions

自

2.0.0

屬性

屬性類型描述定義於
kind?"info" | "warning" | "error"對話方塊的種類。預設為 info。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L87
okLabel?string確認按鈕的標籤。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L89
title?string對話方塊的標題。預設為應用程式名稱。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L85

OpenDialogOptions

開啟對話方塊的選項。

自

2.0.0

屬性

屬性類型描述定義於
canCreateDirectories?boolean是否允許在對話方塊中建立目錄。預設為啟用。僅限 macOS來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L54
defaultPath?string初始目錄或檔案路徑。如果是目錄路徑，對話方塊介面將變更為該資料夾。如果不是現有目錄，檔案名稱將設定為對話方塊的檔案名稱輸入，且對話方塊將設定為父資料夾。在行動裝置上，檔案名稱始終用於對話方塊的檔案名稱輸入。若未提供，Android 會使用 (invalid).txt 作為預設檔案名稱。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L43
directory?boolean對話方塊是否為目錄選擇。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L47
filters?DialogFilter[]對話方塊的篩選器。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L34
multiple?boolean對話方塊是否允許多重選擇。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L45
recursive?boolean如果 directory 為 true，表示稍後將以遞迴方式讀取。定義是否允許在作用域中使用子目錄。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L52
title?string對話方塊視窗的標題 (僅限桌面版)。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L32

SaveDialogOptions

儲存對話方塊的選項。

自

2.0.0

屬性

屬性類型描述定義於
canCreateDirectories?boolean是否允許在對話方塊中建立目錄。預設為啟用。僅限 macOS來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L77
defaultPath?string初始目錄或檔案路徑。如果是目錄路徑，對話方塊介面將變更為該資料夾。如果不是現有目錄，檔案名稱將設定為對話方塊的檔案名稱輸入，且對話方塊將設定為父資料夾。在行動裝置上，檔案名稱始終用於對話方塊的檔案名稱輸入。若未提供，Android 會使用 (invalid).txt 作為預設檔案名稱。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L75
filters?DialogFilter[]對話方塊的篩選器。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L66
title?string對話方塊視窗的標題 (僅限桌面版)。來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L64

類型別名

OpenDialogReturn<T>

type OpenDialogReturn<T>: T["directory"] extends true ? T["multiple"] extends true ? string[] | null : string | null : T["multiple"] extends true ? string[] | null : string | null;

類型參數

類型參數
T extends OpenDialogOptions

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L103

函式

ask()

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

顯示帶有 Yes 和 No 按鈕的問題對話方塊。

參數

參數類型描述
messagestring要顯示的訊息。
options?string | ConfirmDialogOptions對話方塊的選項。如果是字串，則代表對話方塊標題。

回傳

Promise<boolean>

一個 Promise，解析為布林值，指示是否點擊了 Yes。

範例

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

自

2.0.0

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L251

confirm()

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

顯示帶有 Ok 和 Cancel 按鈕的問題對話方塊。

參數

參數類型描述
messagestring要顯示的訊息。
options?string | ConfirmDialogOptions對話方塊的選項。如果是字串，則代表對話方塊標題。

回傳

Promise<boolean>

一個 Promise，解析為布林值，指示是否點擊了 Ok。

範例

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

自

2.0.0

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L281

message()

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

顯示帶有 Ok 按鈕的訊息對話方塊。

參數

參數類型描述
messagestring要顯示的訊息。
options?string | MessageDialogOptions對話方塊的選項。如果是字串，則代表對話方塊標題。

回傳

Promise<void>

一個 Promise，指示操作成功或失敗。

範例

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

自

2.0.0

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L222

open()

function open<T>(options): Promise<OpenDialogReturn<T>>

開啟檔案/目錄選擇對話方塊。

選取的路徑會新增至檔案系統和資產協定作用域。當安全性比此 API 的易用性更重要時，建議撰寫專用命令來替代。

請注意，作用域變更不會持久保存，因此當應用程式重新啟動時，這些值會被清除。您可以使用 tauri-plugin-persisted-scope 將其儲存到檔案系統。

類型參數

類型參數
T extends OpenDialogOptions

參數

參數類型
optionsT

回傳

Promise<OpenDialogReturn<T>>

一個 Promise，解析為選取的路徑

範例

import { open } from '@tauri-apps/plugin-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
}
import { open } from '@tauri-apps/plugin-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
}

自

2.0.0

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L163

save()

function save(options): Promise<string | null>

開啟檔案/目錄儲存對話方塊。

選取的路徑會新增至檔案系統和資產協定作用域。當安全性比此 API 的易用性更重要時，建議撰寫專用命令來替代。

請注意，作用域變更不會持久保存，因此當應用程式重新啟動時，這些值會被清除。您可以使用 tauri-plugin-persisted-scope 將其儲存到檔案系統。

參數

參數類型
optionsSaveDialogOptions

回傳

Promise<string | null>

一個 Promise，解析為選取的路徑。

範例

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

自

2.0.0

來源： https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/dialog/guest-js/index.ts#L197

© 2025 Tauri Contributors. CC-BY / MIT