https://github.com/snosme/electron-overlay-window

Creating overlays is easy like never before
https://github.com/snosme/electron-overlay-window

electron

Last synced: 3 months ago
JSON representation

Creating overlays is easy like never before

• Host: GitHub
• URL: https://github.com/snosme/electron-overlay-window
• Owner: SnosMe
• License: mit
• Created: 2020-06-04T12:08:31.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-26T08:52:53.000Z (about 1 year ago)
• Last Synced: 2025-03-29T11:04:39.470Z (3 months ago)
• Topics: electron
• Language: C
• Homepage:
• Size: 77.1 KB
• Stars: 213
• Watchers: 5
• Forks: 42
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# electron-overlay-window

[![](https://img.shields.io/npm/v/electron-overlay-window/latest?color=CC3534&label=electron-overlay-window&logo=npm&labelColor=212121)](https://www.npmjs.com/package/electron-overlay-window)

Library for creating overlay windows, intended to complement Electron.

Responsible for:

  - Finding target window by title

  - Keeping position and size of overlay window with target in sync

  - Emits lifecycle events

![yarn demo:electron](https://i.imgur.com/Ej190zc.gif)

Important notes:

  - You can initialize library only once (Electron window must never die, and title by which target window is searched cannot be changed)

  - You can have only one overlay window

  - Found target window remains "valid" even if its title has changed

  - Correct behavior is guaranteed only for top-level windows *(A top-level window is a window that is not a child window, or has no parent window (which is the same as having the "desktop window" as a parent))*

  - X11: library relies on EWHM, more specifically `_NET_ACTIVE_WINDOW`, `_NET_WM_STATE_FULLSCREEN`, `_NET_WM_NAME`

Supported backends:

  - Windows (7 - 10)

  - Linux (X11)

Recommended dev utils

- Windows: AccEvent (accevent.exe) and Inspect Object (inspect.exe) from Windows SDK

- X11: xwininfo, xprop, xev