tauri-plugin-wallpaper 2.0.2

A Tauri plugin to set your window as wallpaper behind desktop icons
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# Tauri Plugin Wallpaper (✨)


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

---

<div align="center">

![license](https://badgen.net/badge/license/MIT/blue)
![issues](https://badgen.net/github/issues/meslzy/tauri-plugin-wallpaper)
![stars](https://badgen.net/github/stars/meslzy/tauri-plugin-wallpaper)

</div>

---

## Available platforms (🚧)


- [x] Windows
- [ ] MacOS
- [ ] Linux

---

## Getting Started (✅)


### Installation (⏬)


  - cargo

    ```bash
    cargo add tauri-plugin-wallpaper

    ```

  - npm

    ```bash
    npm install tauri-plugin-wallpaper

    ```

### How to use (🌠)


- cargo

```rust
#[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()) // add this line
        .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

```ts
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();
```

### Permissions (🔑)


If you want to use the javascript bindings, you need to add the following permissions.

`default.json`

```json
{
  "identifier": "default",
  "description": "enables the default permissions",
  "windows": [
    ...
  ],
  "permissions": [
    "core:default",
    "wallpaper:default" // add this line
  ]
}
```

See [reference](./permissions/autogenerated/reference.md) for more permissions options.

---

## The End (💘)