npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

toggle-event-listener

v0.3.2

Published

Declaratively add or remove DOM element event handlers

Downloads

5

Readme

toggleEventListener() is an element classList.toggle() style API for element event handlers.

  • Familiar API
  • Tiny. Only 69 lines of code, including comments and argument error checking.
  • No external dependencies
  • Unit tested
  • Assumes Weakmap and Set are globally available
  • Assumes DOM elements have addEventListener and removeEventListener methods

Demo

https://toggle-event-listener-js-demo.glitch.me

Install

npm install --save toggle-event-listener

or

yarn add toggle-event-listener

API

If you've used an element's classList.toggle() method then you already know this API.

There are two argument signatures:

toggleEventListener(element, type, handler)

This will toggle the binding of the handler.

toggleEventListener(element, type, handler, shouldBeBound)

This lets you declare the status of the binding. If the shouldBeBound argument is truthy, the handler will be present. If it's falsey, the handler will be not be present.

Example Usage

Imagine that a closeModal click handler should only be present on the document body element when the modal is active.

import toggleEventListener from "toggle-event-listener";

export const renderBodyElement = ({ isModalActive, closeModal }) => {
  toggleEventListener(document.body, "click", closeModal, isModalActive);
};

Example Usage with React

This is particularly useful in a React application because React cannot render to the document body element.

When combined with the shouldComponentUpdate React component lifecycle method, you can render to the body like you would any other element and have the element changed only when the state changes.

import React, { Component, PureComponent } from "react";
import toggleEventListener from "toggle-event-listener";

class RenderBodyCloseModalHandler extends Component {
  shouldComponentUpdate(nextProps) {
    return (
      nextProps.isModalActive !== this.props.isModalActive &&
      nextProps.closeModal !== this.props.closeModal
    );
  }
  render() {
    const { closeModal, isModalActive } = this.props;
    toggleEventListener(document.body, "click", closeModal, isModalActive);
    return null;
  }
}

// Or use PureComponent because it defines shouldComponentUpdate
class RenderBodyCloseModalHandler extends PureComponent {
  render() {
    const { closeModal, isModalActive } = this.props;
    toggleEventListener(document.body, "click", closeModal, isModalActive);
    return null;
  }
}