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

@practicaljs/react-eventchannel

v1.0.1

Published

Simple react hooks for consuming and producing events with callbacks

Downloads

22

Readme

About The Project

React Event Channel is a simple library to create an event channel that is easy to use and allows components to trigger events to other components.

But not why just use the context or redux?

While there is nothing wrong with using context or redux to trigger events, I just find it cleaner and more natural to raise an event without having to set up reducers, and actions or create contexts for a simple click. For example, you have an implementation of a save button that calls a function onClick={submitInformation}, and now you want to move the button to the header to use as a global save button. With this package, you can trigger that event with minimal effort and still know that it works like any other event.

Getting Started

Installation

npm i @practicaljs/react-eventchannel

Usage

From any component where you want to raise an event call the producer

const [ handleClick ] = useEventProduce({eventName:'doSomething'}, [])

From any component that you want to recieve this event from call the subscriber and pass it in a call back with the same name as the event you're listening to.

The callback can return void, any or a Promise

useEventSubscriber({ doSomething: async () => {}}, [])

TIP If you are listening to multiple events you only need one subscriber useEventSubscriber({ event1: () => {}, event2: () => {} })

Notify Producer On Complete

But if you want to notify the producer you are done, lets say you add a spinner on click then want to remove it when the listener is done.

const [ handleClick ] = useEventProducer({eventName:'doSomething',onComplete: (response) => {
    // do what you need to do
}}, [])

And just make sure your subscriber returns a response

useEventSubscriber({ doSomething:  () => "I'm done"}, [])

Passing Arguments To Subscribers

If you want to pass extra information with your event make sure to add it to your trigger function

const [ handleClick ] = useEventProduce({eventName:'doSomething'}, [])
<button onClick={() => {handleClick('Ticket #', 300)}}>Set Ticket</button>

In subcriber

useEventSubscriber({
    doSomething: (_, args) => { console.log(args); } // ["Ticket #", 300]
}, [])

Cancel Bubbling

If you have multiple nested components listening to the event they will all recieve it, but you can stop the event from bubbling up from a child by preventing default.

useEventSubscriber({ doSomething:  (e) => {e.preventDefault()}, [])

You can't stop bubbling with siblings only to the parent