colmado v1.0.8

Colmado is an uncomplicated and minimal flux architecture implementation on top of react contexts.

It proposes a singleton store with modules. Each module has a warehouse, where the data is stored, and a reducer, where actions are defineds. Colmado will create your store and dispatch your actions (change events) to the warehouses. Yes, it's like redux, but home made.

Insted of a framework, it's an architectonic proposal with two helper functions: createStore and useStore. The source code is only 70 lines: easy to read, easy to understand, easy to hack.

Install

npm i --save colmado

Code structure

You can use colmado in your own way –all together in a flat file or scattered throughout your components–, but to ensure scalability and modularity, we propose the following directory structure.

├── index.js # Your app root
├── store # Store root directory
│   ├── index.js # Your store instance
│   ├── greetings # Store module. Open a new folder for each module
│   │   ├── index.js # The module instance
│   │   └── reducer.js # Optional, but if your reducer is getting bigger, you can place your actions in a separate file

Usage

The store

To start with colmado, you have to create your store. Let's do it

import { createStore } from "colmado";
const Store = createStore();

The store modules

Easy! But your store is empty. So, lets create one module.

const myModule = {
  name: "names",
  Component: ({ Warehouse, children }) => {
    const [state, setState] = useState();
    return <Warehouse value={[state, setState]}>{children}</Warehouse>;
  },
};

const storeModules = [myModule];
const Store = createStore(storeModules);

Now you have your warehouse where you can store your data, but nobody is dispatching orders.

Reducers

The store isolate your state from the rest of your application into its warehouses and only allows you to place orders to the dispatcher. To be able to dispatch orders, you have to define your reducer. So, let's go.

const myModule = {
  name: "names",
  Component: ({ Warehouse, children }) => {
    const [state, setState] = useState("Garfield");
    return <Warehouse value={[state, setState]}>{children}</Warehouse>;
  },
  reducer: ({ state, action, payload }) => {
    switch (action) {
      case "SET_NAME":
        return payload;
    }
  },
};

Hook and dispatch

And your colmado store is ready to open its doors. You only have to wrap your react components with the store and use the useStore hook to access the warehouse data and the dispatcher.

import { useStore } from "colmado";
import Store from "./store";

function SayHelloTo() {
  const [store, dispatch] = useStore();

  function setName(ev) {
    const value = ev.currentTarget.name;
    dispatch({
      action: "SET_NAME",
      payload: value,
    });
  }

  return (
    <>
      <select onChange={setName}>
        <option value="Gargamel">Gargamel</option>
        <option value="Suneo">Suneo</option>
      </select>
      <p>Hello, {store.name}!</p>
    </>
  );
}

function App() {
  return (
    <Store>
      <SayHelloTo />
    </Store>
  );
}