useValues
The useValues primitive returns a Values object containing the keyed value data of a Store, and registers a listener so that any changes to that result will cause an update.
useValues(storeOrStoreId?: MaybeAccessor<undefined | StoreOrStoreId>): Accessor<Values>| Type | Description | |
|---|---|---|
storeOrStoreId? | MaybeAccessor<undefined | StoreOrStoreId> | The |
| returns | Accessor<Values> | A |
A Provider component is used to wrap part of an application in a context, and it can contain a default Store or a set of Store objects named by Id. The useValues primitive lets you indicate which Store to get data for: omit the optional parameter for the default context Store, provide an Id for a named context Store, or provide a Store explicitly by reference.
When first rendered, this primitive will create a listener so that changes to the Values will cause an update. When the component containing this primitive is unmounted, the listener will be automatically removed.
Example
This example creates a Store, binds it to the primitive, and reads the resulting Solid Accessor.
import {createRoot} from 'solid-js';
import {createStore} from 'tinybase';
import {useValues} from 'tinybase/ui-solid';
createRoot((dispose) => {
const store = createStore().setValues({open: true});
const values = useValues(store);
console.log(JSON.stringify(values()));
// -> '{"open":true}'
dispose();
});
Since
v8.3.0