# @toolia/use-event-listener

> useEventListener react hook

Latest version **3.0.1** (published 2019-12-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @toolia/use-event-listener
pnpm add @toolia/use-event-listener
yarn add @toolia/use-event-listener
bun add @toolia/use-event-listener
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2019-12-22 |
| First published | 2019-12-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | George O. E. Campbell |
| Maintainers | georgecampbell |
| Keywords | react, hook, EventListener |

## Links

- npm: https://www.npmjs.com/package/@toolia/use-event-listener
- Repository: https://github.com/GCDeveloper/use-event-listener
- Homepage: https://github.com/GCDeveloper/use-event-listener#readme
- Issues: https://github.com/GCDeveloper/use-event-listener/issues
- npm.io page: https://npm.io/package/@toolia/use-event-listener

## Dependencies (1)

- [esm](https://npm.io/package/esm.md) ^3.2.25

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2019-12-22
- 3.0.0 — 2019-12-22
- 2.0.3 — 2019-12-15
- 2.0.2 — 2019-12-15

## README

# useEventListener

React hook for `element.addEventListener` and `element.removeEventListener`.

### Install

`npm i @toolia/use-event-listener`

or

`yarn add @toolia/use-event-listener`

> Requires React >= 16.8.0 installed

### Arguments

`(targetElement, eventName, eventHandler[, { initialiseOnAttach = false, logAttachChange = false }, listenerOpts])`

These arguments are used to add / remove event listeners like so:

`targetElement.addEventListener(eventName, eventHandler, listenerOpts);`

initialiseOnAttach will trigger `eventHandler` when the event listener is first attached.

logAttachChange will console.warn when either `.addEventListener` or `.removeEventListener` are called.

### Example usage

This example registers the 'resize' event listener with a throttled handler function to obtain the viewport width and height.

```
import React, { useState, useCallback } from "react";
import useEventListener from '@toolia/use-event-listener';
import { throttle } from 'throttle-debounce';

const Viewport = () => {
  const [{ width, height}, setSize] = useState(initialSize);

  const throttledGetWindowSize = useCallback(throttle(300, e => {
    const target = e.target;
    console.log('resizing with', target.innerWidth);
    setSize({
      width: target.innerWidth,
      height: target.innerHeight
    });
  }), [ throttle ]);

  const [listeningToSize, setListenToSize] = useEventListener(window, 'resize',
    throttledGetWindowSize,
    {
      initialiseOnAttach: true,
      logAttachChange: true
    }
  );
  
  return (
    <div>
      <p>width: {width}</p>
      <p>height: {height}</p>
      <p>Listening to resize? {!!listeningToSize}</p>
      <button onClick={()=>setListenToSize(b => !b)}>{listeningToSize ? 'Stop listening' : 'Listen'}</button>
    </div>
  );
};
```

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