consolidated-events

What is consolidated-events?

The consolidated-events npm package is designed to optimize event handling in web applications. It allows developers to add event listeners that are automatically consolidated, reducing the number of separate event listeners that need to be managed and improving performance, especially in scenarios with many event listeners.

What are consolidated-events's main functionalities?

Add consolidated event listener

This feature allows you to add an event listener to an element, which will be consolidated with other listeners for the same event type, improving performance.

import { addEventListener } from 'consolidated-events';

const listener = event => console.log('Event fired:', event);
const options = { passive: true, capture: false };
const removeEventListener = addEventListener(window, 'resize', listener, options);

Remove consolidated event listener

This feature provides a way to remove a previously added consolidated event listener, ensuring that the listener is properly cleaned up and does not cause memory leaks.

import { addEventListener } from 'consolidated-events';

const listener = event => console.log('Event fired:', event);
const options = { passive: true, capture: false };
const removeEventListener = addEventListener(window, 'resize', listener, options);

// Later, when you want to remove the event listener:
removeEventListener();

Other packages similar to consolidated-events

dom-listener

The dom-listener package provides a way to add and remove event listeners with automatic deduplication, similar to consolidated-events. However, it may not have the same level of consolidation and performance optimization as consolidated-events.

react-event-listener

While react-event-listener is designed specifically for React applications, it offers similar functionality to consolidated-events by providing a declarative API for event listeners. It differs in that it is tailored to work within the React ecosystem.

eventemitter3

EventEmitter3 is an implementation of the EventEmitter module found in Node.js but for the browser. It allows you to emit and listen for custom events. It's not specifically for consolidating native DOM event listeners, but it can be used to manage custom event systems within an application.

README

consolidated-events

Manage multiple event handlers using few event listeners.

Example

import { addEventListener } from 'consolidated-events';

const removeEventListener = addEventListener(
  window,
  'scroll',
  () => { console.log('scrolling') },
  { passive: true }
);

...

removeEventListener();

Changelog

v2.0.0

• Now built with rollup (#8)
• Deprecated removeEventListener export removed (#13)
• Passive event listener test is now removed after being added (#11)
• Reduced bundle size impact by replacing a class with a function (#12)