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-channel-store

v1.0.8

Published

React component decorator for `channel-store` middleware plugin to expose the ambient state to components

Downloads

16

Readme

react-channel-store

React component decorator for channel-store middleware plugin to expose the ambient state to components

Bundlephobia gzip + minified

Installation

yarn add react-channel-store

npm install react-channel-store

Use

First, follow the installation instructions for channel-store and react-channel-event

In your App startup create a IHub instance and add the store middleware createStoreMiddleware.


import { createHub } from "channel-event";
import { createStoreMiddleware, IStoreEvents } from "channel-store";

export interface AppState {
   count: number
}


const hub = createHub(...);

const store = createStoreMiddleware<AppState>(hub)
                  .addDefaultState({ count: 4 })
                  .build();

Then wrap the root of your App with ChannelEventProvider to allow react components to access the hub you created in the last step

      <ChannelEventProvider hub={hub}>
            <App />
      </ChannelEventProvider>

Now, components can be decorated with Connect to inject state values into the props.

import { Connect, IStoreConnect } from "react-channel-store";
import { IStoreEvents } from "channel-store";
import { ChannelEvent, ChannelProps } from "react-channel-event";

// map the state into component's props
@Connect<Props>(state => ({
   countMember: state.count
}))
export default class Test extends React.PureComponent<Props, State> {
   render() {
      // the state's count member now is accessable as this.props.countMember
      return (
         <div>
            <button
               onClick={() =>
                  this.props.setStore(state => ({ count: state.count + 1 }))
               }
            >
               send count
            </button>
            {this.props.countMember}
         </div>
      );
   }
}

// or without a decorator

// export default Connect(state => ({
//   countMember: state.count
// }))(Test);

interface Props extends IStoreConnect<AppState> {
   countMember: number;
}

interface State {}

Add the @ChannelEvent() decorator, as well as the ChannelProps<...> interface to the props (typescript only), to access the channel in this.props.channel