# mouse-movement

> Mouse movement info

Latest version **0.0.9** (published 2019-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install mouse-movement
pnpm add mouse-movement
yarn add mouse-movement
bun add mouse-movement
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2019-09-04 |
| First published | 2018-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Philip Hussak |
| Maintainers | wiseoldman |
| Keywords | mouse, movement, direction, speed, velocity, mouse movement, mouse direction, mouse speed, mouse velocity |

## Links

- npm: https://www.npmjs.com/package/mouse-movement
- Repository: https://github.com/wiseoldman/mouse-movement
- Homepage: https://github.com/wiseoldman/mouse-movement#readme
- Issues: https://github.com/wiseoldman/mouse-movement/issues
- npm.io page: https://npm.io/package/mouse-movement

## Recent versions

- 0.0.9 (latest) — 2019-09-04
- 0.0.8 — 2018-08-10
- 0.0.7 — 2018-06-30
- 0.0.6 — 2018-06-30
- 0.0.5 — 2018-06-30
- 0.0.4 — 2018-06-30
- 0.0.3 — 2018-06-30
- 0.0.2 — 2018-06-30
- 0.0.1 — 2018-06-30

## README

# MouseMovement.js

[![Github file size](https://img.shields.io/github/size/wiseoldman/mouse-movement/dist/MouseMovement.js.svg?style=flat-square)](https://github.com/wiseoldman/mouse-movement) [![GitHub issues](https://img.shields.io/github/issues/wiseoldman/mouse-movement.svg?style=flat-square)](https://github.com/wiseoldman/mouse-movement/issues) [![npm](https://img.shields.io/npm/v/npm.svg?style=flat-square)](https://www.npmjs.com/package/mouse-movement) [![GitHub license](https://img.shields.io/github/license/wiseoldman/mouse-movement.svg?style=flat-square)](https://github.com/wiseoldman/mouse-movement/blob/master/LICENSE)

Get the mouse movement direction and speed (using requestAnimationFrame)

## Installation

```shell
$ npm install mouse-movement
```

## Usage

Listen for mouse movement on the window

```js
import MouseMovement from 'mouse-movement';

const mouseMovement = new MouseMovement();
mouseMovement.init({mousemoveCallback: mouseMovementCallback});

let mouseMovementCallback = function () {
    console.log(mouseMovement.directionX);
    console.log(mouseMovement.speedX);
    console.log(mouseMovement.directionY);
    console.log(mouseMovement.speedY);
    console.log(mouseMovement.diagonal);
}
```

Listen for mouse movement on one or more elements

```js
import MouseMovement from 'mouse-movement';

const mouseMovement = new MouseMovement('.element');
mouseMovement.init({mousemoveCallback: mouseMovementCallback});

let mouseMovementCallback = function () {
    console.log(mouseMovement.directionX);
    console.log(mouseMovement.speedX);
    console.log(mouseMovement.directionY);
    console.log(mouseMovement.speedY);
    console.log(mouseMovement.diagonal);
}
```

Remove all listeners associated with the class

```js
mouseMovement.destroy();
```

## Examples

Coming soon

---
_Source: https://npm.io/package/mouse-movement · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._