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

state-broadcast

v1.0.0

Published

> State that lives in Broadcast channel. Keep the state between tabs.

Downloads

212

Readme

state-broadcast

State that lives in Broadcast channel. Keep the state between tabs.

state-broadcast is a lightweight JavaScript library that simplifies state management across browser tabs. It leverages the BroadcastChannel API to provide a seamless way to keep your application state synchronized in different tabs.

This is particularly useful for scenarios where you need to reflect changes made in one tab instantly in all other open tabs, such as:

  • Real-time updates: Displaying notifications, messages, or data updates across multiple tabs.
  • User settings synchronization: Keeping user preferences consistent across different instances of your application.
  • Collaborative features: Enabling real-time collaboration on shared data or documents.

Install

npm install state-broadcast

Usage

Here's a basic example demonstrating how to use state-broadcast:

import { stateBroadcast } from "state-broadcast";

// Create a new broadcast state with an initial value
const counterState = stateBroadcast("my-state", 0);

// Subscribe to state changes
counterState.subscribe(() => {
  console.log("Counter updated:", newValue);
});

counterState.setState(counterState.getSnapshot() + 1);

React Integration

state-broadcast can be easily integrated with React applications using the useSyncExternalStore hook:

import { stateBroadcast } from "state-broadcast";
import { useSyncExternalStore } from "react";

const counterState = stateBroadcast("counter", 0);

export default function Counter() {
  const count = useSyncExternalStore(
    counterState.subscribe,
    counterState.getSnapshot,
  );

  const increment = () => counterState.setState(count + 1);

  return (
    <div>
      <span>Count: {count}</span>
      <button onClick={increment}>Increment</button>
    </div>
  );
}

HTML demo react-counter.html

API

stateBroadcast

Creates a new broadcast state.

Syntax

stateBroadcast(channelName[, initialState])

Parameters

  • channelName <string>: The name of the channel.
  • initialState Optional <any>: The initial state.

Sample

const state = stateBroadcast("my-state");

state.subscribe(() => {
  console.log("updated state:", state.getSnapshot());
});

StateBroadcast: subscribe() method

Syntax

subscribe(callback);

Parameters

  • callback <function>: The callback function to be called when the state changes.

Return Value

  • void: No return value.

Sample

const state = stateBroadcast("my-state");

state.subscribe(() => {
  console.log("updated state:", state.getSnapshot());
});

StateBroadcast: getSnapshot() method

Alias getState

Syntax

getSnapshot();

Return Value

  • any: The current state.

Sample

const state = stateBroadcast("my-state");

// Long time

console.log(state.getSnapshot()); // { "say": "hello" }

StateBroadcast: setSnapshot() method

Alias setState

Syntax

setSnapshot(newState);

Parameters

  • newState <any>: The new state to be set.

Return Value

  • void: No return value.

Sample

const state = stateBroadcast("my-state");

state.setSnapshot({ say: "hello" });