react-client-store v1.0.0-rc.1

react-client-store

react-client-store is a lightweight and flexible state management library for React applications. It provides a simple way to create a global store with easy-to-use hooks and higher-order components for handling state and dispatching actions.

Features

• Simple and minimalistic API
• Concurrent safe — utilizes React state primitives
• Zero external stores
• SSR, SSG, RSC friendly
• Optimized rendering with memoization
• 100% conformance to React rules. No internal hacks, nor skipping hook dependencies.

Installation

To install react-client-store, run the following command:

npm install react-client-store

Usage

1. Create a store

First, create a store with the initial state and the reducers:

import {createStore} from 'react-client-store';

const init = () => ({
  count: 0,
});

const reducers = {
  increment: (state, params) => ({...state, count: state.count + 1}),
  decrement: (state, params) => ({...state, count: state.count - 1}),
};

const store = createStore(init, reducers);

2. Use the Provider

Wrap your application with the store's Provider component:

import React from 'react';
import {createRoot} from 'react-dom/client';
import {store} from './store';

import App from './App';

const root = createRoot(document.getElementById('root'));
root.render(
  <store.Provider>
    <App />
  </store.Provider>,
);

3. Use hooks to access and update the state

In your components, use the useEmitEvent hook to dispatch actions:

import React from 'react';
import {store} from './store';

function Counter() {
  const emitEvent = store.hooks.useEmitEvent();

  const increment = () => emitEvent('increment');
  const decrement = () => emitEvent('decrement');

  return (
    <div>
      <button onClick={decrement}>-</button>
      <button onClick={increment}>+</button>
    </div>
  );
}

export default Counter;

4. Bind state properties to your components

Use the bindProps function to connect your components to the store:

import React from 'react';
import {store} from './store';

function Display({count}) {
  return <div>{count}</div>;
}

export default store.bindProps(Display, 'count');

API

createStore(init, reducers)

• init: A function that returns the initial state of your store.
• reducers: An object containing reducer functions for handling actions.

Returns an object containing the Provider, hooks, and bindProps function.

Provider

A React component that wraps your application and provides the global store context.

hooks

An object containing hooks for working with the store.

useEmitEvent()

Returns a function that can be used to dispatch actions in your components.

bindProps(Component, selector)

• Component: The React component to connect to the store.
• selector: A function, string, or array that defines which state properties should be passed as props to the connected component.

Returns a new component connected to the store.

License

MIT License. See LICENSE for more information.