@nwbm/use-event

React hooks for subscribing to event emitters.

Installation

npm install @nwbm/use-event

---

useDomEvent

Subscribe to events on DOM elements.

import { useDomEvent } from '@nwbm/use-event'

const Component = () => {
  const ref = useRef(null)
  useDomEvent(ref, 'click', e => console.log(e))
  return <div ref = {ref} />
}

// Listener options 
useDomEvent(ref, 'scroll', e => console.log(e), { passive: true })

// Listen to multiple events at once
useDomEvent(ref, ['click', 'keypress'], e => console.log(e))

More details in dedicated page.

---

useEvent

Low-level hook for subscribing to arbitrary event emitters.

Supports targets providing any of following interfaces:

• on / off
• addEventListener / removeEventListener
• addListener / removeListener

import { useEvent } from '@nwbm/use-event'

// With EventEmitter
const emitter = new EventEmitter()
...
useEvent(emitter, 'my-event', e => console.log(e))
...
emitter.emit('my-event')

See detailed usage examples in dedicated page.