Node module that allows you to attach a window as wallpaper in Windows.
Switch branches/tags
Nothing to show
Clone or download
Latest commit a193fd7 Aug 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Initial commit Aug 19, 2018
docs fix: rearranged the readme Aug 20, 2018
example Initial commit Aug 19, 2018
lib Initial commit Aug 19, 2018
media Initial commit Aug 19, 2018
scripts fix: +x on prebuild script Aug 20, 2018
src Initial commit Aug 19, 2018
.eslintrc.yml Initial commit Aug 19, 2018
.gitignore Initial commit Aug 19, 2018
.npmignore Initial commit Aug 19, 2018
.travis.yml Initial commit Aug 19, 2018
CHANGELOG.md Initial commit Aug 19, 2018
LICENSE Initial commit Aug 19, 2018
Pipfile Initial commit Aug 19, 2018
Pipfile.lock Initial commit Aug 19, 2018
README.md fix: rearranged the readme Aug 20, 2018
appveyor.yml Initial commit Aug 19, 2018
binding.gyp Initial commit Aug 19, 2018
package-lock.json Fix: Updated electron Aug 27, 2018
package.json Fix: Updated electron Aug 27, 2018

README.md

electron-wallpaper

Node module that allows you to attach a window as wallpaper in Windows.

npm NpmVersion NpmLicense AppVeyor branch Travis (.org) branch

This module only supports Windows

electron-wallpaper allows you to insert a Window between the wallpaper and the desktop icons in Windows. User input interaction with the window is not possible, therefore this module is suitable if you wish to build a desktop dashboard application such as Rainmeter but use Electron and NodeJS.

Example application

Example application gif

An example application is located in the /example/ dir, start it by running:

$ npm run example

Installation

Install electron-wallpaper by running:

$ npm install --save electron-wallpaper

Native binaries for win, mac and linux are prebuilt and downloaded when the module is installed.

Documentation

electron-wallpaper.attachWindow(window)

Kind: static method of electron-wallpaper
Summary: Attach a window as wallpaper
Access: public

Param Type Description
window BrowserWindow Window to attach as wallpaper

Example

const electronWallpaper = require('electron-wallpaper');
const currentWindow = require('electron').remote.getCurrentWindow();

electronWallpaper.attachWindow(currentWindow);

Contribute

Feel free to contribute to this module.

Before submitting a PR, please make sure that the linter runs without any warning:

$ npm run lint

License

The project is licensed under the Apache 2.0 license.