Function useStore

A hook used to access a store created with createStore and bind it to a component.

Example

Basic usage:

import { useStore } from "@fransek/statekit";
import { store } from "./store";

function Counter() {
  const {
    state: { count },
    actions: { increment, decrement, reset },
  } = useStore(store);

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

Example

With a select function:

const {
  state: { count },
} = useStore(globalStore, (state) => state.counter);

Remarks

If the select function is provided, an equality check is performed. This has some caveats:

  • For optimal performance, return a direct reference to the state. (e.g. state.count)
  • If you return an object literal, it should only contain direct references to the state. (e.g. { count: state.count })

Settings

Member Visibility