📦 tauri-apps / tauri-plugin-dialog

Native system dialogs for opening and saving files along with message dialogs.

Install

This plugin requires a Rust version of at least 1.77.2

There are three general methods of installation that we can recommend.

• Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
• Pull sources directly from Github using git tags / revision hashes (most secure)
• Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-dialog = "2.0.0"
# alternatively with Git:
tauri-plugin-dialog = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

Linux XDG Desktop Portal Support

By default, this plugin uses gtk to show dialogs, however since v2.5.0 you can switch to using XDG Desktop Portal by adding the following to your Cargo.toml file:

[dependencies]
tauri-plugin-dialog = { version = "2.5.0", default-features = false, features = ["xdg-portal"] }
# alternatively with Git:
tauri-plugin-dialog = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2", default-features = false, features = ["xdg-portal"] }

Do note if you use the xdg-portal feature, you need to ensure that zenity and an XDG Desktop Portal backend is installed with your program.

For more information, see XDG Desktop Portal documentation and rfd documentation.

JavaScript

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

pnpm add @tauri-apps/plugin-dialog
# or
npm add @tauri-apps/plugin-dialog
# or
yarn add @tauri-apps/plugin-dialog

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_dialog::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.