https://github.com/robinwassen/electron-wallpaper

Node module that allows you to attach a window as wallpaper in Windows.
https://github.com/robinwassen/electron-wallpaper

electron nodejs

Last synced: 5 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/robinwassen/electron-wallpaper
• Owner: robinwassen
• License: apache-2.0
• Created: 2018-08-19T17:35:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-07T23:00:36.000Z (about 6 years ago)
• Last Synced: 2025-11-04T22:17:27.272Z (8 months ago)
• Topics: electron, nodejs
• Language: C++
• Size: 525 KB
• Stars: 146
• Watchers: 9
• Forks: 19
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


electron-wallpaper

=========

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

[![npm](https://img.shields.io/npm/dw/electron-wallpaper.svg)](https://npmjs.com/package/electron-wallpaper)

[![NpmVersion](https://img.shields.io/npm/v/electron-wallpaper.svg)](https://npmjs.com/package/electron-wallpaper)

[![NpmLicense](https://img.shields.io/npm/l/electron-wallpaper.svg)](https://npmjs.com/package/electron-wallpaper)

[![AppVeyor branch](https://img.shields.io/appveyor/ci/robinwassen/electron-wallpaper/master.svg?logo=appveyor)](https://ci.appveyor.com/project/robinwassen/electron-wallpaper)

[![Travis (.org) branch](https://img.shields.io/travis/robinwassen/electron-wallpaper/master.svg?logo=travis)](https://travis-ci.org/robinwassen/electron-wallpaper)

*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](https://rainmeter.net) but use Electron and NodeJS.

Example application

-------------

![Example application gif](./media/electron-wallpaper-example.gif)

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

```sh

$ npm run example

```

Installation

------------

Install `electron-wallpaper` by running:

```sh

$ 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](#module_electron-wallpaper)  

**Summary**: Attach a window as wallpaper  

**Access**: public  

| Param | Type | Description |

| --- | --- | --- |

| window | BrowserWindow | Window to attach as wallpaper |

**Example**  

```js

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:

```sh

$ npm run lint

```

License

-------

The project is licensed under the Apache 2.0 license.