# jspointerlock

> W3C Pointer Lock Fallback

Latest version **1.0.0** (published 2017-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install jspointerlock
pnpm add jspointerlock
yarn add jspointerlock
bun add jspointerlock
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-02-04 |
| First published | 2016-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | ardean |
| Maintainers | ardean |
| Keywords | pointer-lock, pointerlock, html5-pointer-lock, w3c-pointer-lock, fallback, jspointerlock, w3c, events, browser, jsremote |

## Links

- npm: https://www.npmjs.com/package/jspointerlock
- Repository: https://github.com/ardean/jsPointerLock
- Homepage: https://github.com/ardean/jsPointerLock#readme
- Issues: https://github.com/ardean/jsPointerLock/issues
- npm.io page: https://npm.io/package/jspointerlock

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-02-04
- 0.4.1 — 2017-02-04
- 0.4.0 — 2017-02-04
- 0.3.3 — 2017-02-02
- 0.3.2 — 2017-02-02
- 0.3.1 — 2017-02-02
- 0.3.0 — 2017-02-02
- 0.2.0 — 2016-12-16
- 0.1.3 — 2016-10-29
- 0.1.2 — 2016-10-29
- 0.1.1 — 2016-10-29
- 0.1.0 — 2016-10-29

## README

# jsPointerLock
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![License][license-image]][license-url]

**W3C Pointer Lock Fallback**

## Specification
[Pointer Lock API, W3C](https://w3c.github.io/pointerlock/)

## Usage

I suggest you to use [jspm](http://jspm.io/) as your package manager.

```js
import PointerLock from "jspointerlock";

const pointerLock = new PointerLock(document.body);

pointerLock.on("change", (isLocked) => {
  console.log(`pointer is ${isLocked ? 'locked' : 'not locked'}`);
});

pointerLock.element.addEventListener("click", () => {
  pointerLock.requestPointerLock();
});
```

### Directly in a browser

Please checkout the [index-dist.html](https://ardean.github.io/jsPointerLock/index-dist.html) file for direct usage in a browser.

## API

### Classes

- _PointerLock_
  - **Constructor**(**Element** element) extends **[EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter)**
  - **Members**
    - _requestPointerLock()_ => **Void**
  - **Static Members**
    - _exitPointerLock()_ => **Void**
  - **Properties**
    - _element_ => **Element**
    - _isLocked_ => **Boolean**
  - **Static Properties**
    - _isSupported_ => **Boolean**
    - _pointerLockElement_ => **Element**
  - **Events**
    - _change_ => (**Boolean** _isLocked_, **Event** _e_)
    - _error_ => (**Error** _err_, **Event** _e_)
    - _unsupported_ => ()


## License

[MIT](LICENSE)

[npm-image]: https://img.shields.io/npm/v/jspointerlock.svg
[npm-url]: https://npmjs.org/package/jspointerlock
[downloads-image]: https://img.shields.io/npm/dm/jspointerlock.svg
[downloads-url]: https://npmjs.org/package/jspointerlock
[license-image]: https://img.shields.io/npm/l/jspointerlock.svg
[license-url]: LICENSE

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