Store API Reference

createStoreContext

Function: createStoreContext()

ts
function createStoreContext<TValue>(): object;
function createStoreContext<TValue>(): object;

Defined in: preact-store/src/createStoreContext.tsx:44

Creates a typed Preact context for sharing a bundle of atoms and stores with a subtree.

The returned StoreProvider only transports the provided object through Preact context. Consumers destructure the contextual atoms and stores, then compose them with the existing hooks like useSelector and useAtom.

The object shape is preserved exactly, so keyed atoms and stores remain fully typed when read back with useStoreContext().

Type Parameters

TValue

TValue extends object

Returns

object

StoreProvider()

ts
StoreProvider: (__namedParameters) => Element;
StoreProvider: (__namedParameters) => Element;

Parameters

__namedParameters
children?

ComponentChildren

value

TValue

Returns

Element

useStoreContext()

ts
useStoreContext: () => TValue;
useStoreContext: () => TValue;

Returns

TValue

Example

tsx
const { StoreProvider, useStoreContext } = createStoreContext<{
  countAtom: Atom<number>
  totalsStore: Store<{ count: number }>
}>()

function CountButton() {
  const { countAtom, totalsStore } = useStoreContext()
  const count = useSelector(countAtom)
  const total = useSelector(totalsStore, (state) => state.count)

  return (
    <button
      type="button"
      onClick={() =>
        totalsStore.setState((state) => ({ ...state, count: state.count + 1 }))
      }
    >
      {count} / {total}
    </button>
  )
}
const { StoreProvider, useStoreContext } = createStoreContext<{
  countAtom: Atom<number>
  totalsStore: Store<{ count: number }>
}>()

function CountButton() {
  const { countAtom, totalsStore } = useStoreContext()
  const count = useSelector(countAtom)
  const total = useSelector(totalsStore, (state) => state.count)

  return (
    <button
      type="button"
      onClick={() =>
        totalsStore.setState((state) => ({ ...state, count: state.count + 1 }))
      }
    >
      {count} / {total}
    </button>
  )
}

Throws

When useStoreContext() is called outside the matching StoreProvider.