Giter Club home page Giter Club logo

spacefold's Introduction

spacefold

๐Ÿ—ฃ Use Pub/Sub pattern inside your React applications easily!

GitHub release

๐Ÿ“œ Table of content

๐Ÿ”ฅ ย  Demo

Like always, a counter as a demo: Counter Demo

๐Ÿง ย  Why

React has a declarative API and a unidirectional data flow, this is beatiful and changes a lot the way we write our frontend application, in fact, this changes everything. But, like a lot of things, React has good and bad parts. One of the bad ones, is that sometimes just make a simple communication between modules (internal or external), became hard to do that using props or states and in a lot of cases you will need a context/provider, some state management library or - in worst cases - prop dilling.

Because of that I've beeing used a very simple implementation of an old pattern called Pub/Sub inside my application when I have this type of problem.

โš ๏ธ Disclaimer

This is not intended to replace your state management library or something else. Use this with caution or you can became your system very hard to debug.

๐Ÿ’ป ย  Usage

  • Small. 1.3kb minified!
  • Extremely Simple. Just publishers and subscribers like old ways

Install as project dependency:

$ yarn add spacefold

Now you can start to create your publishers and subscribers

import { useState } from "react";
import { pub, sub, useSub } from "spacefold";

const inc = pub<number>();
const dec = pub<number>();

const counterSub = sub({
  register: [inc, dec] // You need to register which events your subscriber accept
});

const Counter = () => {
  const [state, setState] = useState(0);
  const sub = useSub(counterSub);

  sub.on(inc, (num) => {
    setState(state + num);
  });
  sub.on(dec, (num) => {
    setState(state - num);
  });

  return <div>{state}</div>;
};

const Decrement = () => (
  <button onClick={() => dec.send(2)}>dec</button>
);

const Increment = () => (
  <button onClick={() => inc.send(2)}>inc</button>
);

export const App = () => (
  <div>
    <Counter />
    <Increment />
    <Decrement />
  </div>
);

Yes, simple as that, just a subscriber and a publisher!

๐Ÿ•บ ย  Contribute

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install dependencies using Yarn: yarn install
  3. Make the necessary changes and ensure that the tests are passing using yarn test
  4. Send a pull request ๐Ÿ™Œ

spacefold's People

Contributors

pedronauck avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

spacefold's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.