https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay
Tauri plugin for making a window a desktop underlay, attached to the desktop, above the wallpaper, and below desktop icons.
https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay
tauri tauri-plugin
Last synced: 4 months ago
JSON representation
Tauri plugin for making a window a desktop underlay, attached to the desktop, above the wallpaper, and below desktop icons.
- Host: GitHub
- URL: https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay
- Owner: Charlie-XIAO
- License: mit
- Created: 2024-09-01T18:05:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-08T12:59:08.000Z (4 months ago)
- Last Synced: 2025-07-08T14:05:53.302Z (4 months ago)
- Topics: tauri, tauri-plugin
- Language: Rust
- Homepage:
- Size: 21.2 MB
- Stars: 20
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tauri - tauri-plugin-desktop-underlay - Attach a window to desktop, below icons and above wallpaper. (Development / Plugins)
README
# PLUGIN-DESKTOP-UNDERLAY
[](https://v2.tauri.app/)
[](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/tree/main/LICENSE)
[](https://www.npmjs.com/package/tauri-plugin-desktop-underlay-api)
[](https://www.npmjs.com/package/tauri-plugin-desktop-underlay-api)
[](https://crates.io/crates/tauri-plugin-desktop-underlay)
[](https://crates.io/crates/tauri-plugin-desktop-underlay)
[](https://docs.rs/tauri-plugin-desktop-underlay)
Tauri plugin for attaching a window to desktop, below icons and above wallpaper, referred to as a **desktop underlay**.
- **Linux:** Not tested, thus not guaranteed to work.
- **MacOS:** ✅
- **Windows:** ✅
## Examples
- [Desktop Clock](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/tree/main/examples/desktop-clock) [[Demo](https://github.com/user-attachments/assets/894a5afb-269e-4158-af13-add266a69576)]
## Install
Install the desktop underlay plugin by adding the following to your `Cargo.toml` file:
```toml
[dependencies]
tauri-plugin-desktop-underlay = "0.1.1"
```
You can install the JavaScript guest bindings using your preferred JavaScript package manager:
```bash
npm install tauri-plugin-desktop-underlay-api # or
yarn add tauri-plugin-desktop-underlay-api # or
pnpm add tauri-plugin-desktop-underlay-api
```
## Usage
First you need to register the core plugin with Tauri:
```rust
tauri::Builder::default()
// Initialize the desktop-underlay plugin
.plugin(tauri_plugin_desktop_underlay::init())
.run(tauri::generate_context!())
.unwrap();
```
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
```typescript
import {
setDesktopUnderlay,
isDesktopUnderlay,
toggleDesktopUnderlay,
} from "tauri-plugin-desktop-underlay-api";
```
To operate on the current window:
```typescript
const isUnderlay = await isDesktopUnderlay();
await setDesktopUnderlay(true);
await setDesktopUnderlay(false);
const nowIsUnderlay = await toggleDesktopUnderlay();
```
To operate on another window (say, with label `wallpaper`):
```typescript
const isUnderlay = await isDesktopUnderlay("wallpaper");
await setDesktopUnderlay(true, "wallpaper");
await setDesktopUnderlay(false, "wallpaper");
const nowIsUnderlay = await toggleDesktopUnderlay("wallpaper");
```
If you only intend on using the APIs from Rust code, you can import the `DesktopUnderlayExt` extension on windows and webview windows:
```rust
use tauri_plugin_desktop_underlay::DesktopUnderlayExt;
let main_window = app.get_webview_window("main").unwrap();
let is_underlay = main_window.is_desktop_underlay();
let _ = main_window.set_desktop_underlay(true);
let _ = main_window.set_desktop_underlay(false);
let now_is_underlay = main_window.toggle_desktop_underlay();
```
## Permissions
See [permissions reference](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/tree/main/permissions/autogenerated/reference.md). You do not need to add permissions if you are not using the JavaScript guest bindings.
## Build from Source
If you want to try a local build, or you want to try the [examples](#examples) before deciding whether to use this plugin, you may need to build the source code:
```bash
git clone https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay.git
pnpm install
pnpm build
```
## FAQ
See [FAQ](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/tree/main/FAQ.md) for the list of frequently asked questions. If these do not answer your question and you cannot find an answer in the [issue tracker](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/issues) either, consider [submitting a new issue](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/issues/new).
## Contributing
Feel free to open issues to report bugs or request features and improvements. Since I majorly develop on Windows, there could be many problems on Linux and macOS that I am not aware of. Pull requests are also welcome, though for larger changes it would be generally better to open an issue for discussion first.
## License
Copyright (c) 2024-2025 Yao Xiao [@Charlie-XIAO](https://github.com/Charlie-XIAO); this project is released under the [MIT License](https://github.com/Charlie-XIAO/tauri-plugin-desktop-underlay/tree/main/LICENSE).