TinyBase logoTinyBase β

useStores

The useStores hook is used to get a reference to all the Store objects named by Id within a Provider component context.

useStores(): {[storeId: Id]: Store}
returns{[storeId: Id]: Store}

An object containing all the Store objects named by Id.

A Provider component is used to wrap part of an application in a context. It can contain a default Store (or a set of Store objects named by Id) that can be easily accessed without having to be passed down as props through every component.

The useStores hook lets you get a reference to the latter as an object.

Example

This example creates a Provider context into which a Store is provided, named by Id. A component within it then uses the useStores hook to get a reference to the Store again.

import React from 'react';
import {createRoot} from 'react-dom/client';
import {createStore} from 'tinybase';
import {Provider, useStores} from 'tinybase/ui-react';

const App = ({store}) => (
  <Provider storesById={{petStore: store}}>
    <Pane />
  </Provider>
);
const Pane = () => (
  <span>{useStores()['petStore'].getListenerStats().tables}</span>
);

const store = createStore();
const app = document.createElement('div');
createRoot(app).render(<App store={store} />);
console.log(app.innerHTML);
// -> '<span>0</span>'

Since

v5.4.1