JSPM

  • Created
  • Published
  • Downloads 27832
  • Score
    100M100P100Q146794F
  • License MIT

Lightweight event delegation

Package Exports

  • delegate-it

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (delegate-it) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

delegate-it Build Status

Lightweight event delegation

This is a fork of the popular delegate with some improvements:

  • debugged (2d54c11, c6bb88c)
  • modern: ES6, TypeScript, Edge 15+ (it uses WeakMap and Element.closest())
  • idempotent: identical listeners aren't added multiple times, just like the native addEventListener

If you need IE support, you can keep using delegate

Install

npm install delegate-it

Setup

const delegate = require('delegate-it');
import delegate from 'delegate-it';

Usage

Add event delegation

With the default base (document)

delegate('.btn', 'click', event => {
    console.log(event.delegateTarget);
});

With an element as base

delegate(document.body, '.btn', 'click', event => {
    console.log(event.delegateTarget);
});

With a selector (of existing elements) as base

delegate('.container', '.btn', 'click', event => {
    console.log(event.delegateTarget);
});

With an array/array-like of elements as base

delegate(document.querySelectorAll('.container'), '.btn', 'click', event => {
    console.log(event.delegateTarget);
});

Remove event delegation

With a single base element (default or specified)

const delegation = delegate(document.body, '.btn', 'click', event => {
    console.log(event.delegateTarget);
});

delegation.destroy();

With multiple elements (via selector or array)

Note: selectors are always treated as multiple elements, even if one or none are matched. delegate() will return an array.

const delegations = delegate('.container', '.btn', 'click', event => {
    console.log(event.delegateTarget);
});

delegations.forEach(function (delegation) {
    delegation.destroy();
});

If you're using TypeScript and have event types that are custom, you can override the EventType via declaration merging. e.g. say you have a types/globals.d.ts file, you can add the following.

declare module "delegate-it" {
  // Custom event types used in RGH
  export type EventType = keyof GlobalEventHandlersEventMap | 'details:toggled';
}

In the file that import EventType, you will now be able to set an event type to 'details:toggled'.

import { EventType } from "delegate-it";

const someEventType1: EventType = 'details:toggled'; // all good
const someEventType2: EventType = 'click'; // all good
const someEventType3: EventType = 'some-invalid-event-type'; // no good

Browser Support

Chrome logo Edge logo Firefox logo Internet Explorer logo Opera logo Safari logo
Latest ✔ Latest ✔ Latest ✔ No ✕ Latest ✔ Latest ✔