Skip to content

MattStypa/kedge

Repository files navigation

Kedge

Build Status Latest Stable Version Total Downloads License

Easy to use global state hook for React.

Kedge

Read a little bit more here.

Installation

npm install kedge

Usage

import { createStore, useStore } from 'kedge';

const priceStore = createStore();

function PriceComponent() {
  const price = useStore(priceStore);
  useEffect(fetchPrice, []);

  return (
    <div>
      Price: { price }
    </div>
  );
}

function fetchPrice() {
  priceStore.set(73);
}

API

  • const store = createStore(initialState, optionalName)

Creates a Store with initial value. Optionally, it accepts a store name that is used in React Dev Tools

  • const state = useStore(store)

Returns current state from the Store and subscribes the component to it. If the Store changes state the component will re-render.

  • Store.set(newState)

Sets Store state and re-renders all components that use it.

  • Store.reset()

Sets Store to initial value and re-renders all components that use it.

About

Easy to use global state hook for React.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published