global-mouse-events
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

global-mouse-events

Global mouse events listener for Node.js (Windows only). Based off of sentialx/mouse-hooks and coldKey1/mouse-hooks.

Installation

npm i global-mouse-events

Usage

Import the module and register for the mouse events you'd like to listen to.

Available event listeners

mouseup / mousedownFires when a mouse button is pressed / released.
Returns:

  • x: The X position of the mouse, relative to the top left of the primary display.
  • y: The Y position of the mouse, relative to the top left of the primary display.
  • button: Which button was pressed. 1 is left-click. 2 is right-click. 3 is middle-click. 4 and 5 are side buttons ("XBUTTON1" and "XBUTTON2").

mousemoveFires when the mouse cursor is moved.
Returns:

  • x: The X position of the mouse, relative to the top left of the primary display.
  • y: The Y position of the mouse, relative to the top left of the primary display.

mousewheelFires when the mouse wheel is scrolled. Some trackpads may not fire this event unless "Scroll inactive windows when I hover over them" is disabled in the Windows settings.
Returns:

  • x: The X position of the mouse, relative to the top left of the primary display.
  • y: The Y position of the mouse, relative to the top left of the primary display.
  • delta: How much the mouse wheel was scrolled. Positive numbers are considered "up" and negative numbers are "down".
  • axis: Whether the scroll was vertical or horizontal. 0 is vertical. 1 is horizontal.

Example

const mouseEvents = require("global-mouse-events");

mouseEvents.on("mouseup", event => {
  console.log(event); // { x: 2962, y: 483, button: 1 }
});

mouseEvents.on("mousedown", event => {
  console.log(event); // { x: 2962, y: 483, button: 1 }
});

mouseEvents.on("mousemove", event => {
  console.log(event); // { x: 2962, y: 482 }
});

mouseEvents.on("mousewheel", event => {
  console.log(event); // { x: 2962, y: 483, delta: -1, axis: 0 }
});

Available functions

  • pauseMouseEventsPauses all mouse events.
  • resumeMouseEventsResumes all mouse events.
  • getPausedReturns the paused state as a boolean.

Package Sidebar

Install

npm i global-mouse-events

Weekly Downloads

186

Version

1.2.0

License

MIT

Unpacked Size

15.2 kB

Total Files

8

Last publish

Collaborators

  • xanderfrangos