simple-listen
v1.1.2
Published
Utility for adding event listeners with simple unsubscribing
Downloads
491
Maintainers
Readme
Simple Listen
Small utility for adding event listeners that returns the listener for easy unsubscribing
Installation
$ npm install simple-listen
##API
###listen(el, events, cb, capture, context)
el
- the DOM element you are attaching events toevents
- [string|array[string]] - the event types to attachcb
- [function] - the function to call when event firescapture
- [boolean] -false
- use capturecontext
- [object] -null
- the context applied tocb
Example
import listen from 'simple-listen';
const el = document.getElementById('clickable');
const callback = (e) => console.log(e.type);
const myListener = listen(el, 'click mouseenter mouseleave', callback);
myListener(); // remove event listener
// Multiple listeners
const listeners = [];
listeners.push(listen(el, 'click', callback));
listeners.push(listen(el, 'mouseenter', callback));
listeners.push(listen(el, 'mouseleave', callback));
listeners.push(listen(window, 'scroll', callback));
listeners.push(listen(window, 'resize', callback));
// quickly remove the event listeners
listeners.forEach((listener) => listener());
License
Modified BSD