# @render-props/events

> A state container which provides an interface for managing event listeners in its children. This component will automatically garbage collect all of its registered listeners on unmount.

Latest version **0.1.13** (published 2019-03-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @render-props/events
pnpm add @render-props/events
yarn add @render-props/events
bun add @render-props/events
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.13 |
| Published | 2019-03-20 |
| First published | 2018-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 36 |
| Author | Jared Lunde |
| Maintainers | jaredlunde |
| Keywords | react, render props, function as child, hoc, state container, event emitter, events |

## Links

- npm: https://www.npmjs.com/package/@render-props/events
- Repository: https://github.com/jaredlunde/render-props/tree/master/packages/events
- npm.io page: https://npm.io/package/@render-props/events

## Dependencies (1)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.4.0

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.1.13 (latest) — 2019-03-20
- 0.1.12 — 2019-01-31
- 0.1.11 — 2019-01-12
- 0.1.10 — 2018-12-29
- 0.1.9 — 2018-09-11
- 0.1.8 — 2018-09-10
- 0.1.7 — 2018-09-10
- 0.1.6 — 2018-08-21
- 0.1.5 — 2018-08-20
- 0.1.4 — 2018-08-18
- 0.1.3 — 2018-08-18
- 0.1.2 — 2018-02-08
- 0.1.1 — 2018-02-05
- 0.1.0 — 2018-02-05

## README

# Events
A state container which provides an interface for managing event listeners
in its children. This component will automatically garbage collect all of its
registered listeners on unmount.


### Installation
```yarn add @render-props/events``` or ```npm i @render-props/events```


____


## Usage
```js
import Events from '@render-props/events'


class SomeComponent extends React.Component {
  componentDidMount () {
    this.props.addEvent(window, 'resize', this.handleResizeEvent)
  }
}


function SomeComponentWithEvents (props) {
  return (
    <Events>
      {({addEvent, removeEvent, removeAllEvents}) => (
        return (
          <SomeComponent
            addEvent={addEvent}
            removeEvent={removeEvent}
            {...props}
          />
        )
      )}
    </Events>
  )
}
```

____

## Render Props

#### Methods
- `addEvent` `(element, eventName <string>, listener <func>)`
  - adds an event `@listener` for `@eventName` on the provided `@element`
- `removeEvent` `(element, eventName <string>, listener <func>)`
  - removes an event `@listener` for `@eventName` on the provided `@element`
- `removeAllEvents` `([element])`
  - removes listeners from all registered events if no `@element` is provided,
    otherwise removes all listeners attached to `@element`

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