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

react-event-light

v0.0.4

Published

npm package for react app

Downloads

6

Readme

React Event Channel

A simple and lightweight package to facilitate an event-driven architecture in React applications, allowing components to subscribe to and publish events with ease.

Installation

Install the package via npm:

npm install react-event-light -S

Usage

Importing

First, import the useEventLight hook into your React component:

import { useEventLight } from "react-event-channel";

Subscribing to Events

You can subscribe to an event to listen for any data that gets published on that event channel. Here is an example of how to subscribe and handle incoming data:

import React, { useEffect } from "react";
import { useEventLight } from "react-event-channel";

function MyComponent() {
  const [subscribe, publish] = useEventLight();

  useEffect(() => {
    const subscription = subscribe("my-event", (data) => {
      console.log("Received data:", data);
    });

    return () => {
      subscription.unsubscribe();
    };
  }, [subscribe]);

  return <div>Check your console for event data.</div>;
}

export default MyComponent;

Publishing to Events

To publish data to an event channel, so that all subscribers to that channel can receive and process the data, use the publish function like this:

import React from "react";
import { useEventLight } from "react-event-channel";

function PublisherComponent() {
  const [, publish] = useEventLight();

  const sendData = () => {
    publish("my-event", { message: "Hello from PublisherComponent!" });
  };

  return <button onClick={sendData}>Send Event</button>;
}

export default PublisherComponent;

API

  • subscribe(event: REACT_EVENT_LIGHT_CHANNEL_NAME, callback: Callback): Subscribe to an event. Returns an object with an unsubscribe method to stop listening for the event.
  • publish(event: REACT_EVENT_LIGHT_CHANNEL_NAME, data: DataType): Publish data to all subscribers of the specified event.

TypeScript Support

This package includes TypeScript definitions to enhance development experience with type checking.

Enjoy using React Event Channel for your event-driven React applications!