Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andstor/mouse-controller
:mouse: Node.js C++ Addon for emulating mouse behavior
https://github.com/andstor/mouse-controller
cpp macos mouse node-addon nodejs
Last synced: 1 day ago
JSON representation
:mouse: Node.js C++ Addon for emulating mouse behavior
- Host: GitHub
- URL: https://github.com/andstor/mouse-controller
- Owner: andstor
- License: mit
- Created: 2019-12-17T00:36:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-22T10:04:24.000Z (almost 3 years ago)
- Last Synced: 2024-10-08T09:33:03.391Z (about 1 month ago)
- Topics: cpp, macos, mouse, node-addon, nodejs
- Language: C++
- Homepage: https://www.npmjs.com/package/mouse-controller
- Size: 80.1 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mouse-controller
> Node.js C++ Addon for emulating mouse behavior
[](https://travis-ci.org/andstor/mouse-controller)
[](https://coveralls.io/github/andstor/mouse-controller?branch=master)
[](https://npmjs.org/package/mouse-controller "View this project on npm")
## Table of Contents
* [Supported Plattforms](#supported-plattforms)
* [Installation](#installation)
* [Usage](#usage)
* [Constants](#constants)
* [Methods](#methods)
* [License](#license)
## Supported Plattforms
Currently supported plattforms are:
- **MacOS**
## Installation
```sh
$ npm install --save mouse-controller
```
[Precompiled binaries](https://github.com/andstor/mouse-controller/releases/latest) for popular 64-bit platforms are provided. When installing `mouse-controller`, [`node-pre-gyp`](https://github.com/mapbox/node-pre-gyp) will check if a compatible binary exists and fallback to a compile step if it doesn't. In that case you'll need a [valid `node-gyp` installation](https://github.com/nodejs/node-gyp#installation).
If you don't want to use the prebuilt binary for the platform you are installing on, specify the `--build-from-source` flag when you install. One of:
```
npm install --build-from-source
npm install mouse-controller --build-from-source
```
## Usage
### Syntax
```js
new MouseController()
```
### Example
```js
const MouseController = require('mouse-controller');
const mc = new MouseController();
console.log(mc.getPosition());
//=> { x: 143.9375, y: 129.0625 }
// Move the mouse to the coordinates (500, 500).
mc.move(500, 500);
// Right click at the current mouse position.
mc.click(mc.BUTTON.RIGHT, mc.getPosition());
```
## Constants
### BUTTON
Constant for specifying the mouse button type.
| Constant | Value | Button |
| :------- | :---: | :----------------- |
| `LEFT` | `0` | Left mouse button |
| `RIGHT` | `1` | Right mouse button |
## Methods
### move(x, y)
- **x**:
- Type: `Number`
- x-coordinate for the new mouse position.
- **y**:
- Type: `Number`
- y-coordinate for the new mouse position.
Moves the mouse to the point (`x`, `y`).
### click(BUTTON, point)
- **BUTTON**:
- Type: [`BUTTON`](#button)
- Which mouse button to click. The [`BUTTON`](#button) type is defined as multiple constants.
- **point**:
- Type: `Object`
- Which mouse button to click.
Clicks with the `BUTTON` at the `point` provided. To click in the corrent position of the mouse, use the method [getPosition()](#getPosition).
### doubleClick(BUTTON, point)
- **BUTTON**:
- Type: [`BUTTON`](#button)
- Which mouse button to click. The [`BUTTON`](#button) type is defined as multiple constants on the BUTTON object.
- **point**:
- Type: `Object`
- Which mouse button to click.
Double clicks with the `BUTTON` at the `point` provided. To click in the corrent position of the mouse, use the method [getPosition()](#getPosition).
### getPosition()
- (return value):
- Type: `Object`
- Returns the current mouse position.
Gets the current mouse position on the form `{ x: 143.9375, y: 129.0625 }`.
### startDrag(point)
- **point**:
- Type: `Object`
- Object with `x` and `y` coordinates of the vanted mouse position to start the mouse drag from.
Start to drag by pressing down on the left mouse button at the point (`x`, `y`). To do consecutive movement while dragging, use the [drag(point)](#dragpoint) method.
### drag(point)
- **point**:
- Type: `Object`
- Object with `x` and `y` coordinates of the vanted mouse position to end the mouse drag on.
To move the mouse that is activly dragging, the point (`x`, `y`).
### endDrag(point)
- **point**:
- Type: `Object`
- Object with `x` and `y` coordinates of the vanted mouse position to end the mouse drag on.
End a mouse drag by releasing the left mouse button at the point (`x`, `y`).
## License
mouse-controller is licensed under the [MIT License](https://github.com/andstor/mouse-controller/blob/master/LICENSE).
Copyright © [André Storhaug](https://github.com/andstor)