readme.md

Electron As Wallpaper (✨)

set your electron window as wallpaper behind desktop icons

---

---

Features (⭐)

• set electron window as wallpaper
• support transparent window
• support mouse forwarding
• support keyboard forwarding

Requirements (⚙️)

• Window OS
  • Window 11 (Tested)
  • Window 10 (Not Tested)
  • Window 8 (Not Tested)
  • Window 7 (Not Tested)
• Rust
• Node.js
• Electron
• Electron Rebuild

Installation (⏬)

npm install electron-as-wallpaper --save

How to use (🌠)

import {attach, detach, reset} from "electron-as-wallpaper";

// attach the window to the desktop wallpaper
attach(mainWindow, {
  transparent: true,
  forwardKeyboardInput: true,
  forwardMouseInput: true,
});

// detach the window from the desktop wallpaper
detach(mainWindow);

// reset the wallpaper (restore the original wallpaper)
reset();

Examples

• demo
• transparent
• input forwarding
• screen size changed

---

The End (💘)