Struct Dialog

pub struct Dialog<R: Runtime>(/* private fields */);

Access to the dialog APIs.

Implementations

impl<R: Runtime> Dialog<R>

pub fn message(&self, message: impl Into<String>) -> MessageDialogBuilder<R>

Create a new messaging dialog builder. The dialog can optionally ask the user for confirmation or include an OK button.

Examples

• Message dialog:

use tauri_plugin_dialog::DialogExt;

tauri::Builder::default()
  .setup(|app| {
    app
      .dialog()
      .message("Tauri is Awesome!")
      .show(|_| {
        println!("dialog closed");
      });
    Ok(())
  });

• Ask dialog:

use tauri_plugin_dialog::{DialogExt, MessageDialogButtons};

tauri::Builder::default()
  .setup(|app| {
    app.dialog()
      .message("Are you sure?")
      .buttons(MessageDialogButtons::OkCancelCustom("Yes", "No"))
      .show(|yes| {
        println!("user said {}", if yes { "yes" } else { "no" });
      });
    Ok(())
  });

• Message dialog with OK button:

use tauri_plugin_dialog::{DialogExt, MessageDialogButtons};

tauri::Builder::default()
  .setup(|app| {
    app.dialog()
      .message("Job completed successfully")
      .buttons(MessageDialogButtons::Ok)
      .show(|_| {
        println!("dialog closed");
      });
    Ok(())
  });

show vs blocking_show

The dialog builder includes two separate APIs for rendering the dialog: show and blocking_show. The show function is asynchronous and takes a closure to be executed when the dialog is closed. To block the current thread until the user acted on the dialog, you can use blocking_show, but note that it cannot be executed on the main thread as it will freeze your application.

use tauri_plugin_dialog::{DialogExt, MessageDialogButtons};

tauri::Builder::default()
  .setup(|app| {
    let handle = app.handle().clone();
    std::thread::spawn(move || {
      let yes = handle.dialog()
        .message("Are you sure?")
        .buttons(MessageDialogButtons::OkCancelCustom("Yes", "No"))
        .blocking_show();
    });

    Ok(())
  });

pub fn file(&self) -> FileDialogBuilder<R>

Creates a new builder for dialogs that lets the user select file(s) or folder(s).

Trait Implementations

impl<R: Runtime> Clone for Dialog<R>

fn clone(&self) -> Self

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R: Debug + Runtime> Debug for Dialog<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.