@lxfater/windows-electron-drag

3.0.1 • Public • Published

electron-drag

Improved window dragging for Electron applications.

Frameless windows can be dragged using the -webkit-app-region css property, but this disables all regular dom events and user interactions with the affected element, which makes it hard to emulate a native-like title bar in the application, as it's not possible to capture double clicks for maximizing the window.

A workaround is to use a pure javascript solution, but dragging only works well when moving the mouse in less than normal speed, else the mouse pointer will move outside the window area and no events will be received by the dom.

This module uses win-mouse modules for tracking the mouse position on the entire screen, and thereby enabling consistent window dragging, while the affected element is still able to receive dom events.

Important

  1. Only work under windows.
  2. If screen scale to 150% on windows, the position will wrong
  3. Make it work well with "@electron/remote" and remember to import { initialize } from "@electron/remote/main"; initialize() in your main file.
  4. This package need rebuild under the electron environment.

Build

The module needs to be built with the correct Electron headers. See the guide for using native Node modules with Electron for more information.

Versions of this library above version 2.0.0 require Electron which support Node.js version 9 and above.

Usage

npm install electron-drag

Require the module in an Electron web page.

var drag = require('electron-drag')

// Pass a query selector or a dom element to the function.
// Dragging the element will drag the whole window.
var clear = drag('#element')

// Call the returned function to make the element undraggable again.
clear()

The module only works on OS X and Windows, but doesn't fail when installed on a non-supported platform.

// Fallback to using -webkit-app-region property.
if (!drag.supported) {
	document.querySelector('#element').style['-webkit-app-region'] = 'drag'
}

Package Sidebar

Install

npm i @lxfater/windows-electron-drag

Weekly Downloads

0

Version

3.0.1

License

MIT

Unpacked Size

4.12 kB

Total Files

3

Last publish

Collaborators

  • lxfater