/tauri-plugin-wallpaper

A Tauri plugin to set your window as wallpaper behind desktop icons

Primary LanguageRust

Tauri Plugin Wallpaper (✨)

A Tauri plugin to set your window as wallpaper behind desktop icons


license issues


Available platforms (🚧)

  • Windows
  • MacOS
  • Linux

Getting Started (✅)

  • Installation (⏬)

    • cargo

      cargo add tauri-plugin-wallpaper
    • npm

      npm install tauri-plugin-wallpaper

How to use (🌠)

  • cargo
use tauri_plugin_wallpaper::Wallpaper;

fn main() {
  tauri::Builder::default().plugin(
    Wallpaper::init(),
  );

  // to attach
  Wallpaper::attach(&window);
  // to detach
  Wallpaper::detach(&window);
}
  • npm
import wallpaper from "tauri-plugin-wallpaper";

wallpaper.attach();
// or
const windowLabel = "My Window Label";
wallpaper.attach(windowLabel);

// to detach
wallpaper.detach();

The End (💘)