tauri-plugin-wallpaper
TypeScript icon, indicating that this package has built-in type declarations

2.0.0-beta • Public • Published

Tauri Plugin Wallpaper (✨)

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


license issues stars


Available platforms (🚧)

  • [x] Windows
  • [ ] MacOS
  • [ ] Linux

Getting Started (✅)

  • Installation (⏬)

    • cargo

      cargo add tauri-plugin-wallpaper
    • npm

      npm install tauri-plugin-wallpaper

How to use (🌠)

  • cargo
#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        .invoke_handler(tauri::generate_handler![show, hide])
        .plugin(tauri_plugin_wallpaper::init())
        .setup(|app| {
            let app_handle = app.handle();
            let webview_window = app_handle.get_webview_window("wallpaper").unwrap();
            // attach window to wallpaper
            app_handle
                .wallpaper()
                .attach_window(&webview_window)
                .unwrap();
            // attach using window label identifier
            app_handle
                .wallpaper()
                .attach(AttachRequest::new("window_label"))
                .unwrap();

            // detach window from wallpaper
            app_handle
                .wallpaper()
                .detach_window(&webview_window)
                .unwrap();

            // detach using window label identifier
            app_handle
                .wallpaper()
                .detach(DetachRequest::new("window_label"))
                .unwrap();

            // reset wallpaper
            app_handle.wallpaper().reset().unwrap();
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}
  • npm
import wallpaper from "tauri-plugin-wallpaper";
// or import { attach, detach, reset } from "tauri-plugin-wallpaper";

// Attach current window as wallpaper
wallpaper.attach();
// or using window label identifier
wallpaper.attach("window-label");

// detach current window from wallpaper
wallpaper.detach();
// or using window label identifier
wallpaper.detach("window-label");

// reset wallpaper
wallpaper.reset();

The End (💘)

Package Sidebar

Install

npm i tauri-plugin-wallpaper

Weekly Downloads

73

Version

2.0.0-beta

License

mit

Unpacked Size

6.04 kB

Total Files

4

Last publish

Collaborators

  • meslzy