# @link-hooks/use-event-listener

> window add event listener

Latest version **1.0.0** (published 2020-10-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @link-hooks/use-event-listener
pnpm add @link-hooks/use-event-listener
yarn add @link-hooks/use-event-listener
bun add @link-hooks/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 | 1.0.0 |
| Published | 2020-10-12 |
| First published | 2020-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | xiguan00yu |
| Maintainers | link-xy-npm |

## Links

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

## Recent versions

- 1.0.0 (latest) — 2020-10-12

## README

# @link-hooks/use-event-listener

> window add event listener

[![NPM](https://img.shields.io/npm/v/@link-hooks/use-event-listener.svg)](https://www.npmjs.com/package/@link-hooks/use-event-listener) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save @link-hooks/use-event-listener
```

## Usage

```tsx
import React, { Component } from 'react'
import useEventListener from '@link-hooks/use-event-listener'

const Example = () => {
  const [hover, setHover] = useState(false)
  //  example-1
  const ref = useEventListener<HTMLDivElement>(
    ['mouseover', 'mouseleave'],
    [() => setHover(true), () => setHover(false)]
  )

  //  example-2
  // const ref = useEventListener<HTMLDivElement>(['mouseover', 'mouseleave'], {
  //   mouseover: () => setHover(true),
  //   mouseleave: () => setHover(false)
  // })

  //  example-3
  // const ref = useEventListener<HTMLDivElement>('mouseover', ) => setHover(true))

  return <div className={`box ${hover ? 'hover' : ''}`} ref={ref} />
}
```

## License

MIT © [xiguan00yu](https://github.com/xiguan00yu)

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