/tauri-plugin-vibrancy

Make your Tao/Tauri windows vibrant.

Primary LanguageRustMIT LicenseMIT

tauri-plugin-vibrancy

Make your Tauri/TAO windows vibrant.

Platform support

  • Windows: Yes!
  • macOS: Yes!
  • Linux: No, blur effect is controlled by the compositor installed on the user system and they can enable it for your app if they want.

Installation

Add it as a dependncy in Cargo.toml of your Tao/Tauri project

[dependencies]
tauri-plugin-vibrancy = { git = "https://github.com/tauri-apps/tauri-plugin-vibrancy", features = ["tauri-impl"] } # or "tao-impl" for TAO projects.

Cargo Features:

  • tauri-impl: for Tauri projects.
  • tao-impl: for TAO projects.

Usage

  1. Enable transparency on your window:
    • Tauri: Edit your window in tauri.conf.json > tauri > windows and add "transparent": true or use tauri::WindowBuilder::transparent.
    • TAO: Use tao::window::WindowBuilder::with_transparent.
  2. Use the Vibrancy trait methods on your window type:
    • Tauri: 
      let window = app.get_window("main").unwrap();

use tauri_plugin_vibrancy::Vibrancy;
#[cfg(target_os = "windows")]
window.apply_blur();
#[cfg(target_os = "macos")]
{
    use tauri_plugin_vibrancy::MacOSVibrancy;
    window.apply_vibrancy(MacOSVibrancy::AppearanceBased);
}
    • Tao: 
      let window = WindowBuilder::new().with_transparent(true).build(&event_loop).unwrap();

use tauri_plugin_vibrancy::Vibrancy;
#[cfg(target_os = "windows")]
window.apply_blur();
#[cfg(target_os = "macos")]
{
    use tauri_plugin_vibrancy::MacOSVibrancy;
    window.apply_vibrancy(MacOSVibrancy::AppearanceBased);
}

Available methods

Please read the methods documentation in src/lib.rs

  • apply_blur() - Windows
  • apply_acrylic() - Windows works on Windows 10 v1809 and above and has bad performance when resizing/dragging the window
  • apply_vibrancy() - macOS thanks to @youngsing

TODOS

  • apply_mica() for Windows 11