# simple-pointer-lock-api

> Simple API for Pointer Lock in Chrome and Firefox

Latest version **0.1.0-beta.2** (published 2014-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-pointer-lock-api
pnpm add simple-pointer-lock-api
yarn add simple-pointer-lock-api
bun add simple-pointer-lock-api
```

## 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.1.0-beta.2 |
| Published | 2014-07-28 |
| First published | 2014-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Pouria Maleki |
| Maintainers | pouriamaleki |
| Keywords | PointerLockAPI, Pointer, Mouse |

## Links

- npm: https://www.npmjs.com/package/simple-pointer-lock-api
- Repository: https://github.com/PouriaMaleki/simple-pointer-lock-api
- Issues: https://github.com/PouriaMaleki/simple-pointer-lock-api/issues
- npm.io page: https://npm.io/package/simple-pointer-lock-api

## Recent versions

- 0.1.0-beta.2 (latest) — 2014-07-28
- 0.1.0-beta.1 — 2014-07-28

## README

(work in progress)

Simple Pointer Lock API

For Chrome(webkit) and Firefox(Gecko) browsers.


	Pointer = require 'simple-pointer-lock-api'

	pointer = new Pointer

	pointer
	.on 'start', =>

		console.log 'start'

	.on 'firstMove', =>

		console.log 'firstMove'

	.on 'move', (event) =>

		console.log 'move'

		console.log event

	.on 'end', =>

		console.log 'end'


	document.addEventListener 'click', =>

		pointer.request(document.body)

		# or this will force end:
		# pointer.release()

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